Harmonization of token Parameter Descriptions and Type Definitions in `hf_api.py` about huggingface_hub HOT 8 CLOSED

Thanks for looking in this @lappemic! Totally agree with you this would benefit from some harmonization.

For the record, ~2y ago tokens where not used by default, hence the boolean value. Now, tokens are always sent when the user is logged in (either via env variable or huggingface-cli login). So the only boolean value that is relevant is token=False to explicitly refuse authentication.

So if there is harmonization, it should be towards

Option 2: token: Union[bool, str, None] = None

About the attribute description. I would update it to mention that the recommended way to login is not by using this arg but rather login the machine itself. What do you think of:

"A valid user access token (string). If not set, will default to the locally saved one. Pass token=False to explicitly disable authentication. Note that the recommended way to authenticate is usually with a locally saved token (see https://huggingface.co/docs/huggingface_hub/quick-start#authentication)."

?

from huggingface_hub.

The description sounds reasonable and is clear 👍

I will open a PR for this the next days.

from huggingface_hub.

And thanks for raising this topic + propose your help on this one! It's something that always bothered me but never really addressed 😄

from huggingface_hub.

The second version is definitely less verbose. I just stumble across the "Finally" in the last sentence which is in my understanding like the last step in an "actionchain" (regardless the actions before). I do not want to make it picky, but what would you think about:

A valid user access token (string). Defaults to the locally saved token, which is the recommended method for authentication (see Hugging Face Hub Quick Start). To disable authentication, pass False.

from huggingface_hub.

Thanks for the suggestion, let's use that! I'd just update it to set the url directly in the docstring. I think it's better for users reading the srouce code directly (so not rendered),

A valid user access token (string). Defaults to the locally saved token, which is the recommended method for authentication (see https://huggingface.co/docs/huggingface_hub/quick-start#authentication). To disable authentication, pass False.

from huggingface_hub.

Close by @lappemic in #2252. Thanks!

from huggingface_hub.

Second version? (less verbose)

"A valid user access token (string). If not set, will default to the locally saved one which is the recommended way to authenticate (see https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Finally, pass False to explicitly disable authentication."

from huggingface_hub.

And thanks for raising this topic + propose your help on this one! It's something that always bothered me but never really addressed 😄

Haha, addressing every itch would just be too overwhelming 😅 Glad i can help out here!

from huggingface_hub.