Skip to content

Commit 4c70f5e

Browse files
add notebooks in repo to model release checklist (#1825)
--------- Co-authored-by: vb <[email protected]>
1 parent ab07edf commit 4c70f5e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/hub/model-release-checklist.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ A well-crafted model card (the `README.md` file in your repository) is essential
3636

3737
3. **Usage Examples**: Provide clear, actionable code snippets that demonstrate how to use your model for inference, fine-tuning, or other common tasks. These examples should be ready to copy and run with minimal modifications.
3838

39+
Bonus: You can showcase your model capabilities by placing a well structured `notebook.ipynb` in the model repository. This would allow users to directly open your notebook and run it in [Google Colab and Kaggle Notebooks](https://huggingface.co/docs/hub/en/notebooks) directly.
40+
3941
4. **Technical Specifications**: Include information about training parameters, hardware requirements, and any other technical details that would help users understand how to effectively use your model.
4042

4143
5. **Performance Metrics**: Share comprehensive benchmarks and evaluation results. Include both quantitative metrics and qualitative examples to give users a complete picture of your model's capabilities and limitations.

0 commit comments

Comments
 (0)