huggingface_hub.loginhuggingface_hub.loginhttps://github.com/huggingface/huggingface_hub/blob/v1.0.0.rc6/src/huggingface_hub/_login.py#L59[{"name": "token", "val": ": typing.Optional[str] = None"}, {"name": "add_to_git_credential", "val": ": bool = False"}, {"name": "skip_if_logged_in", "val": ": bool = False"}]- **token** (`str`, *optional*) -- User access token to generate from https://huggingface.co/settings/token. - **add_to_git_credential** (`bool`, defaults to `False`) -- If `True`, token will be set as git credential. If no git credential helper is configured, a warning will be displayed to the user. If `token` is `None`, the value of `add_to_git_credential` is ignored and will be prompted again to the end user. - **skip_if_logged_in** (`bool`, defaults to `False`) -- If `True`, do not prompt for token if user is already logged in.0- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- If an organization token is passed. Only personal account tokens are valid to log in. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- If token is invalid. - [`ImportError`](https://docs.python.org/3/library/exceptions.html#ImportError) -- If running in a notebook but `ipywidgets` is not installed.``ValueError`` or ``ImportError`` Login the machine to access the Hub. The `token` is persisted in cache and set as a git credential. Once done, the machine is logged in and the access token will be available across all `huggingface_hub` components. If `token` is not provided, it will be prompted to the user either with a widget (in a notebook) or via the terminal. To log in from outside of a script, one can also use `hf auth login` which is a cli command that wraps [login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.login). > [!TIP] > [login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.login) is a drop-in replacement method for [notebook_login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.notebook_login) as it wraps and > extends its capabilities. > [!TIP] > When the token is not passed, [login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.login) will automatically detect if the script runs > in a notebook or not. However, this detection might not be accurate due to the > variety of notebooks that exists nowadays. If that is the case, you can always force > the UI by using [notebook_login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.notebook_login) or [interpreter_login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.interpreter_login).

huggingface_hub.interpreter_loginhuggingface_hub.interpreter_loginhttps://github.com/huggingface/huggingface_hub/blob/v1.0.0.rc6/src/huggingface_hub/_login.py#L231[{"name": "skip_if_logged_in", "val": ": bool = False"}]- **skip_if_logged_in** (`bool`, defaults to `False`) -- If `True`, do not prompt for token if user is already logged in.0 Displays a prompt to log in to the HF website and store the token. This is equivalent to [login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.login) without passing a token when not run in a notebook. [interpreter_login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.interpreter_login) is useful if you want to force the use of the terminal prompt instead of a notebook widget. For more details, see [login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.login).

huggingface_hub.notebook_loginhuggingface_hub.notebook_loginhttps://github.com/huggingface/huggingface_hub/blob/v1.0.0.rc6/src/huggingface_hub/_login.py#L293[{"name": "skip_if_logged_in", "val": ": bool = False"}]- **skip_if_logged_in** (`bool`, defaults to `False`) -- If `True`, do not prompt for token if user is already logged in.0 Displays a widget to log in to the HF website and store the token. This is equivalent to [login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.login) without passing a token when run in a notebook. [notebook_login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.notebook_login) is useful if you want to force the use of the notebook widget instead of a prompt in the terminal. For more details, see [login()](/docs/huggingface_hub/v1.0.0.rc6/en/package_reference/authentication#huggingface_hub.login).

huggingface_hub.logouthuggingface_hub.logouthttps://github.com/huggingface/huggingface_hub/blob/v1.0.0.rc6/src/huggingface_hub/_login.py#L119[{"name": "token_name", "val": ": typing.Optional[str] = None"}]- **token_name** (`str`, *optional*) -- Name of the access token to logout from. If `None`, will logout from all saved access tokens.0- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- If the access token name is not found.``ValueError`` Logout the machine from the Hub. Token is deleted from the machine and removed from git credential.

huggingface_hub.auth_switchhuggingface_hub.auth_switchhttps://github.com/huggingface/huggingface_hub/blob/v1.0.0.rc6/src/huggingface_hub/_login.py#L161[{"name": "token_name", "val": ": str"}, {"name": "add_to_git_credential", "val": ": bool = False"}]- **token_name** (`str`) -- Name of the access token to switch to. - **add_to_git_credential** (`bool`, defaults to `False`) -- If `True`, token will be set as git credential. If no git credential helper is configured, a warning will be displayed to the user. If `token` is `None`, the value of `add_to_git_credential` is ignored and will be prompted again to the end user.0- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- If the access token name is not found.``ValueError`` Switch to a different access token.