Skip to content

Commit 3a20e3f

Browse files
authored
Update model-release-checklist.md (#1671)
* Update model-release-checklist.md * Update model-release-checklist.md * Update model-release-checklist.md
1 parent 05ad311 commit 3a20e3f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/hub/model-release-checklist.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@ The Hugging Face Hub is the go-to platform for sharing machine learning models.
88

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

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-
- leverage [safetensors](https://huggingface.co/docs/safetensors/en/index) for weights serialization as opposed to pickle.
11+
### Uploading Weights
12+
13+
- **Use separate repositories for different model weights.** For example, you can store quantization variants for the same model in a single repository, but use separate repositories for different model weights.
14+
15+
- **Prefer [`safetensors`](https://huggingface.co/docs/safetensors/en/index) over `pickle` for weight serialization.** `safetensors` offers improved safety and performance compared to Python's `pickle`.
1316

1417
### Writing a Comprehensive Model Card
1518

@@ -39,7 +42,6 @@ A well-crafted model card (the `README.md` file in your repository) is essential
3942

4043
6. **Limitations and Biases**: Transparently document any known limitations, biases, or ethical considerations associated with your model. This helps users make informed decisions about whether and how to use your model.
4144

42-
4345
### Enhancing Model Discoverability and Usability
4446

4547
To maximize your model's reach and usability:

0 commit comments

Comments
 (0)