Skip to content

Commit 7813634

Browse files
Update checklist (#1658)
* First draft * Update section * Update docs/hub/model-release-checklist.md Co-authored-by: vb <[email protected]> * Update docs --------- Co-authored-by: vb <[email protected]>
1 parent b97ffbb commit 7813634

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/hub/model-release-checklist.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ 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
8+
9+
When uploading models to the hub, it's recommended to follow a set best practices:
10+
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+
- leverage [safetensors](https://huggingface.co/docs/safetensors/en/index) for weights serialization as opposed to pickle.
14+
15+
We wrote an extensive guide on uploading best practices [here](models-uploading).
16+
717
### Writing a Comprehensive Model Card
818

919
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:

0 commit comments

Comments
 (0)