You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/hub/model-release-checklist.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,13 @@ The Hugging Face Hub is the go-to platform for sharing machine learning models.
4
4
5
5
## ⏳ Preparing Your Model for Release
6
6
7
-
### Uploading models
7
+
### Uploading weights
8
8
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:
10
10
11
11
- 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.
13
12
- leverage [safetensors](https://huggingface.co/docs/safetensors/en/index) for weights serialization as opposed to pickle.
14
13
15
-
We wrote an extensive guide on uploading best practices [here](models-uploading).
16
-
17
14
### Writing a Comprehensive Model Card
18
15
19
16
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:
58
55
59
56
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.
60
57
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
+
61
62
Bonus: a recognised library also allows you to track downloads of your model over time.
62
63
63
64
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