Skip to content

Commit 880e3dc

Browse files
authored
Update Hub and huggingface_hub docs (#293)
* Improve docs * Wrap for 80 chars * Uppercase git
1 parent dab2020 commit 880e3dc

File tree

2 files changed

+183
-92
lines changed

2 files changed

+183
-92
lines changed

docs/hub/adding-a-model.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Uploading models to the Hugging Face Hub has many [benefits](https://huggingface
1010

1111
## Accounts and organizations
1212

13-
The first step is to create an account at [Hugging Face](https://huggingface.co/login). The models are shared in the form of git-based repositories. You have control over your repository, so you can have checkpoints, configs and any files you might want to upload.
13+
The first step is to create an account at [Hugging Face](https://huggingface.co/login). The models are shared in the form of Git-based repositories. You have control over your repository, so you can have checkpoints, configs and any files you might want to upload.
1414

1515
The repository can be either linked with an individual, such as [osanseviero/fashion_brands_patterns](https://huggingface.co/osanseviero/fashion_brands_patterns) or with an organization, such as [facebook/bart-large-xsum](https://huggingface.co/facebook/bart-large-xsum). Organizations can be used if you want to upload models that are related to a company, community or library! If you choose an organization, the model will be featured on the organization’s page and every member of the organization will have the ability to contribute to the repository. You can create a new organization [here](https://huggingface.co/organizations/new).
1616

@@ -55,6 +55,10 @@ There is only one key difference if you have large files (over 10MB). These file
5555

5656
2. Run `git lfs install` to initialize **git-lfs**:
5757

58+
Do you have files larger than 10MB? Those files are tracked with `git-lfs`. We already provide a list of common file extensions for these files in `.gitattributes`, but you might need to add new extensions if they are not already handled. You can do so with `git lfs track "*.your_extension"`.
59+
60+
Once ready, just run:
61+
5862
```
5963
git lfs install
6064
```
@@ -74,7 +78,7 @@ Now's the time 🔥. You can add any files you want to the repository.
7478

7579
5. Commit and push your files
7680

77-
You can do this with the usual Git workflow
81+
You can do this with the usual Git workflow:
7882

7983
```
8084
git add .

0 commit comments

Comments
 (0)