diff --git a/docs/hub/model-release-checklist.md b/docs/hub/model-release-checklist.md index 4f5dc005f3..c993a1ab2e 100644 --- a/docs/hub/model-release-checklist.md +++ b/docs/hub/model-release-checklist.md @@ -36,6 +36,8 @@ A well-crafted model card (the `README.md` file in your repository) is essential 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. +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. + 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. 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.