Skip to content

Update checklist #1658

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

Merged
merged 4 commits into from
Mar 31, 2025
Merged

Update checklist #1658

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0272bb4
First draft
NielsRogge Mar 31, 2025
4171157
Update section
NielsRogge Mar 31, 2025
7f3934c
Update docs/hub/model-release-checklist.md
NielsRogge Mar 31, 2025
895a797
Update docs
NielsRogge Mar 31, 2025
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
10 changes: 10 additions & 0 deletions docs/hub/model-release-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ The Hugging Face Hub is the go-to platform for sharing machine learning models.

## ⏳ Preparing Your Model for Release

### Uploading models

When uploading models to the hub, it's recommended to follow a set best practices:

- push weights to separate model repositories. Example: prefer uploading individual quantizations/precisions in a standalone repo like [this](https://huggingface.co/jameslahm/yolov10n) over all types/versions in one like [this](https://huggingface.co/kadirnar/Yolov10/tree/main).
Copy link
Contributor

@gary149 gary149 Mar 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would look better if the list was capitalized and more consistant

Copy link
Contributor Author

@NielsRogge NielsRogge Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will submit a follow-up PR

Copy link
Contributor Author

@NielsRogge NielsRogge Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nvm just saw #1660, I assume that resolves it

- adopt the [Mixin class](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) when pushing custom PyTorch models.
- leverage [safetensors](https://huggingface.co/docs/safetensors/en/index) for weights serialization as opposed to pickle.

We wrote an extensive guide on uploading best practices [here](models-uploading).

### Writing a Comprehensive Model Card

A well-crafted model card (the `README.md` file in your repository) is essential for discoverability, reproducibility, and effective sharing. Your model card should include:
Expand Down