Rename huggingface_cli to hf (#39630)

* Rename huggingface_cli to hf

* hfh
This commit is contained in:
Lysandre Debut
2025-07-25 14:10:04 +02:00
committed by GitHub
parent 3b3f9c0c46
commit f90de364c2
111 changed files with 132 additions and 132 deletions

View File

@@ -79,5 +79,5 @@ To specify a given repository name, use the `--hub_model_id` argument. You will
A few notes on this integration:
- you will need to be logged in to the Hugging Face website locally for it to work, the easiest way to achieve this is to run `huggingface-cli login` and then type your username and password when prompted. You can also pass along your authentication token with the `--hub_token` argument.
- you will need to be logged in to the Hugging Face website locally for it to work, the easiest way to achieve this is to run `hf auth login` and then type your username and password when prompted. You can also pass along your authentication token with the `--hub_token` argument.
- the `output_dir` you pick will either need to be a new folder or a local clone of the distant repository you are using.

View File

@@ -186,7 +186,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -172,7 +172,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -173,7 +173,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -179,7 +179,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -173,7 +173,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -159,7 +159,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -192,7 +192,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -107,7 +107,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -155,7 +155,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -163,7 +163,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -90,7 +90,7 @@ To specify a given repository name, use the `--hub_model_id` argument. You will
A few notes on this integration:
- you will need to be logged in to the Hugging Face website locally for it to work, the easiest way to achieve this is to run `huggingface-cli login` and then type your username and password when prompted. You can also pass along your authentication token with the `--hub_token` argument.
- you will need to be logged in to the Hugging Face website locally for it to work, the easiest way to achieve this is to run `hf auth login` and then type your username and password when prompted. You can also pass along your authentication token with the `--hub_token` argument.
- the `output_dir` you pick will either need to be a new folder or a local clone of the distant repository you are using.
## Distributed training and mixed precision

View File

@@ -115,10 +115,10 @@ On 4 V100 GPUs (16GB), this script should run in ~1 hour and yield accuracy of *
$ apt install git-lfs
```
2. Log in with your HuggingFace account credentials using `huggingface-cli`
2. Log in with your HuggingFace account credentials using `hf`
```bash
$ huggingface-cli login
$ hf auth login
# ...follow the prompts
```

View File

@@ -167,7 +167,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -100,7 +100,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -129,7 +129,7 @@ dataset = load_dataset("imagefolder", data_files={"train": ["path/to/file1", "pa
Next, push it to the hub!
```python
# assuming you have ran the huggingface-cli login command in a terminal
# assuming you have ran the hf auth login command in a terminal
dataset.push_to_hub("name_of_your_dataset")
# if you want to push to a private repo, simply pass private=True:
@@ -152,10 +152,10 @@ $ git config --global user.email "you@example.com"
$ git config --global user.name "Your Name"
```
2. Log in with your HuggingFace account credentials using `huggingface-cli`:
2. Log in with your HuggingFace account credentials using `hf`:
```bash
$ huggingface-cli login
$ hf auth login
# ...follow the prompts
```

View File

@@ -168,7 +168,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -239,10 +239,10 @@ $ git config --global user.email "you@example.com"
$ git config --global user.name "Your Name"
```
2. Log in with your HuggingFace account credentials using `huggingface-cli`
2. Log in with your HuggingFace account credentials using `hf`
```bash
$ huggingface-cli login
$ hf auth login
# ...follow the prompts
```

View File

@@ -156,7 +156,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -166,7 +166,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -200,7 +200,7 @@ def parse_args():
default=None,
help=(
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
),
)
parser.add_argument(

View File

@@ -97,7 +97,7 @@ class Arguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -130,7 +130,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -133,7 +133,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -127,7 +127,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -114,7 +114,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -94,7 +94,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -217,7 +217,7 @@ dataset = load_dataset("imagefolder", data_dir="custom_dataset/")
# ... })
# ... })
# Push to hub (assumes you have ran the huggingface-cli login command in a terminal/notebook)
# Push to hub (assumes you have ran the hf auth login command in a terminal/notebook)
dataset.push_to_hub("name of repo on the hub")
# optionally, you can push to a private repo on the hub

View File

@@ -320,7 +320,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -84,7 +84,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -82,7 +82,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -84,7 +84,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -66,7 +66,7 @@ dataset = DatasetDict({
}
)
# step 3: push to hub (assumes you have ran the huggingface-cli login command in a terminal/notebook)
# step 3: push to hub (assumes you have ran the hf auth login command in a terminal/notebook)
dataset.push_to_hub("name of repo on the hub")
# optionally, you can push to a private repo on the hub
@@ -98,7 +98,7 @@ The script leverages the [🤗 Trainer API](https://huggingface.co/docs/transfor
Here we show how to fine-tune a [SegFormer](https://huggingface.co/nvidia/mit-b0) model on the [segments/sidewalk-semantic](https://huggingface.co/datasets/segments/sidewalk-semantic) dataset:
In order to use `segments/sidewalk-semantic`:
- Log in to Hugging Face with `huggingface-cli login` (token can be accessed [here](https://huggingface.co/settings/tokens)).
- Log in to Hugging Face with `hf auth login` (token can be accessed [here](https://huggingface.co/settings/tokens)).
- Accept terms of use for `sidewalk-semantic` on [dataset page](https://huggingface.co/datasets/segments/sidewalk-semantic).
```bash

View File

@@ -168,7 +168,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -278,7 +278,7 @@ accordingly be called `adapter.{<target_language}.safetensors`.
Let's run an example script. Make sure to be logged in so that your model can be directly uploaded to the Hub.
```bash
huggingface-cli login
hf auth login
```
Now, let's run an example and upload it to the Hub under `wav2vec2-common_voice-tr-mms-demo`.
@@ -448,7 +448,7 @@ By pairing a pretrained speech model with a pretrained text model, the warm-star
As an example, let's instantiate a *Wav2Vec2-2-Bart* model with the `SpeechEncoderDecoderModel` framework. First create an empty repo on `hf.co`:
```bash
huggingface-cli repo create wav2vec2-2-bart-base
hf repo create wav2vec2-2-bart-base
git clone https://huggingface.co/<your-user-name>/wav2vec2-2-bart-base
cd wav2vec2-2-bart-base
```

View File

@@ -258,7 +258,7 @@ class DataTrainingArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -248,7 +248,7 @@ class DataTrainingArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -102,7 +102,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -119,7 +119,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -250,7 +250,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -208,7 +208,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -171,7 +171,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -95,7 +95,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -108,7 +108,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -96,7 +96,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -122,7 +122,7 @@ dataset = load_dataset("imagefolder", data_files={"train": ["path/to/file1", "pa
Next, push it to the hub!
```python
# assuming you have ran the huggingface-cli login command in a terminal
# assuming you have ran the hf auth login command in a terminal
dataset.push_to_hub("name_of_your_dataset")
# if you want to push to a private repo, simply pass private=True:
@@ -145,10 +145,10 @@ $ git config --global user.email "you@example.com"
$ git config --global user.name "Your Name"
```
2. Log in with your HuggingFace account credentials using `huggingface-cli`:
2. Log in with your HuggingFace account credentials using `hf`:
```bash
$ huggingface-cli login
$ hf auth login
# ...follow the prompts
```

View File

@@ -162,7 +162,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -35,7 +35,7 @@ python train_unigram.py --batch_size 1000 --vocab_size 25000 --export_to_hub
The script will automatically load the `train` split of the WikiText dataset and train a [Unigram tokenizer](https://huggingface.co/course/chapter6/7?fw=pt) on it.
> 💡 **Note**: In order for `export_to_hub` to work, you must authenticate yourself with the `huggingface-cli`. Run `huggingface-cli login` and follow the on-screen instructions.
> 💡 **Note**: In order for `export_to_hub` to work, you must authenticate yourself with the `hf`. Run `hf auth login` and follow the on-screen instructions.
## Preparing the dataset

View File

@@ -116,7 +116,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -114,7 +114,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -87,7 +87,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -95,7 +95,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -103,7 +103,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -168,7 +168,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -188,7 +188,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -79,7 +79,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)

View File

@@ -97,7 +97,7 @@ class ModelArguments:
metadata={
"help": (
"The token to use as HTTP bearer authorization for remote files. If not specified, will use the token "
"generated when running `huggingface-cli login` (stored in `~/.huggingface`)."
"generated when running `hf auth login` (stored in `~/.huggingface`)."
)
},
)