Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Hub and huggingface_hub docs #293

Merged
merged 3 commits into from
Aug 24, 2021
Merged

Update Hub and huggingface_hub docs #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09efdbd
Improve docs
osanseviero Aug 24, 2021
8fb783e
Wrap for 80 chars
osanseviero Aug 24, 2021
2d7a588
Uppercase git
osanseviero Aug 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/hub/adding-a-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Uploading models to the Hugging Face Hub has many [benefits](https://huggingface

## Accounts and organizations

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.
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.

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).

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

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

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"`.

Once ready, just run:

```
git lfs install
```
Expand All @@ -74,7 +78,7 @@ Now's the time 🔥. You can add any files you want to the repository.

5. Commit and push your files

You can do this with the usual Git workflow
You can do this with the usual Git workflow:

```
git add .
Expand Down
Loading