Hugging Face's logo

Hub Python Library documentation

Аутентификация

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Аутентификация

Библиотека huggingface_hub позволяет пользователям программно управлять аутентификацией в Hub. Это включает вход в систему, выход, переключение между токенами и просмотр списка доступных токенов.

Для получения подробной информации об аутентификации обратитесь к этому разделу.

вход

huggingface_hub.login

< >

( token: str | None = Noneadd_to_git_credential: bool = Falseskip_if_logged_in: bool = True )

Параметры

  • token (str, необязательный) — Токен доступа пользователя для генерации с https://huggingface.co/settings/token.
  • add_to_git_credential (bool, по умолчанию False) — Если True, токен будет установлен как git credential. Если git credential helper не настроен, пользователю будет выведено предупреждение. Используется только при предоставлении token; игнорируется в браузерном потоке.
  • skip_if_logged_in (bool, по умолчанию True) — Если True, не запрашивать токен, если пользователь уже вошёл в систему. Установите False, чтобы принудительно выполнить повторный вход. В CLI используйте вместо этого --force.

Исключения

ValueError или DeviceCodeError

  • ValueError — Если передан токен организации. Для входа действительны только токены личных аккаунтов.
  • ValueError — Если токен недействителен.
  • DeviceCodeError — Если вход через браузер не удался (отказ в авторизации, код истёк, …).

Выполните вход на машину для доступа к Hub.

Токен token сохраняется в кэше и устанавливается как git-учётные данные. После завершения процесса машина оказывается в состоянии авторизации, и токен доступа становится доступен во всех компонентах huggingface_hub. Если параметр token не указан, для аутентификации используется браузерный OAuth-поток: открывается URL, вводится короткий код, после чего токен извлекается и сохраняется. В терминале также можно вставить существующий токен доступа.

Чтобы войти извне скрипта, можно также использовать hf auth login — это команда CLI, которая оборачивает login().

Если токен не передан, login() автоматически определит, выполняется ли скрипт в ноутбуке. Однако из-за разнообразия существующих на данный момент ноутбуков этот механизм определения может работать неточно. В таком случае вы всегда можете принудительно запустить интерфейс, используя notebook_login() или interpreter_login().

interpreter_login

huggingface_hub.interpreter_login

< >

( skip_if_logged_in: bool = True )

Параметры

  • skip_if_logged_in (bool, по умолчанию True) — Если True, не запрашивать токен, если пользователь уже вошёл в систему. Установите False, чтобы принудительно выполнить повторный вход. В CLI используйте вместо этого --force.

Отображает запрос на вход на сайт HF и сохранение токена.

Это эквивалентно вызову login() без передачи токена, если код не выполняется в ноутбуке. interpreter_login() полезен, если вы хотите принудительно использовать терминальный запрос вместо сценария для ноутбука.

Подробнее см. login().

notebook_login

huggingface_hub.notebook_login

< >

( skip_if_logged_in: bool = True )

Параметры

  • skip_if_logged_in (bool, по умолчанию True) — Если True, не запрашивать токен, если пользователь уже вошёл в систему. Установите False, чтобы принудительно выполнить повторный вход. В CLI используйте вместо этого --force.

Отображает запрос на вход на сайт HF и сохранение токена.

Это эквивалентно вызову login() без передачи токена при запуске в ноутбуке. notebook_login() полезен, если вы хотите принудительно использовать сценарий для ноутбука, а не запрос в терминале.

Подробнее см. login().

выйти

huggingface_hub.logout

< >

( token_name: str | None = None )

Параметры

  • token_name (str, необязательный) — Имя токена доступа, от которого требуется отключиться. Если None, произойдёт отключение от всех сохранённых токенов доступа.

Исключения

ValueError

  • ValueError — Если имя токена доступа не найдено.

Выйдите с машины из Hub.

Токен удалён с машины и исключён из git credential.

auth_switch

huggingface_hub.auth_switch

< >

( token_name: stradd_to_git_credential: bool = False )

Параметры

  • token_name (str) — Имя токена доступа, на который нужно переключиться.
  • add_to_git_credential (bool, по умолчанию False) — Если True, токен будет установлен как git credential. Если git credential helper не настроен, пользователю будет выведено предупреждение. Если token равно None, значение add_to_git_credential игнорируется, и от конечного пользователя снова будет запрошено значение.

Исключения

ValueError

  • ValueError — Если имя токена доступа не найдено.

Переключитесь на другой токен доступа.

auth_list

huggingface_hub.auth_list

< >

( )

Список всех сохраненных токенов доступа.

Update on GitHub

←Обзор Переменные окружения→