Skip to content

Commit 78bca23

Browse files
authored
Update model-release-checklist.md (#1660)
1 parent 7813634 commit 78bca23

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/hub/model-release-checklist.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,13 @@ The Hugging Face Hub is the go-to platform for sharing machine learning models.
44

55
## ⏳ Preparing Your Model for Release
66

7-
### Uploading models
7+
### Uploading weights
88

9-
When uploading models to the hub, it's recommended to follow a set best practices:
9+
When uploading models to the hub, it's recommended to follow a set of best practices:
1010

1111
- 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).
12-
- adopt the [Mixin class](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) when pushing custom PyTorch models.
1312
- leverage [safetensors](https://huggingface.co/docs/safetensors/en/index) for weights serialization as opposed to pickle.
1413

15-
We wrote an extensive guide on uploading best practices [here](models-uploading).
16-
1714
### Writing a Comprehensive Model Card
1815

1916
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:
@@ -58,6 +55,10 @@ To maximize your model's reach and usability:
5855

5956
You can also [create your own model library](https://huggingface.co/docs/hub/models-adding-libraries) or add Hub support to another existing library or codebase.
6057

58+
Finally, you can adopt the [Mixin class](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) when pushing custom PyTorch models.
59+
60+
We wrote an extensive guide on uploading best practices [here](https://huggingface.co/docs/hub/models-uploading).
61+
6162
Bonus: a recognised library also allows you to track downloads of your model over time.
6263

6364
2. **Pipeline Tag Selection**: Choose the correct [pipeline tag](https://huggingface.co/docs/hub/model-cards#specifying-a-task--pipelinetag-) that accurately reflects your model's primary task. This tag determines how your model appears in search results and which widgets are displayed on your model page.

0 commit comments

Comments
 (0)