Improve model card: Add pipeline tag, paper link, abstract, code link, and usage examples
#3
by
nielsr
HF Staff
- opened
This PR significantly enhances the model card for RouteFinder: Towards Foundation Models for Vehicle Routing Problems by:
- Adding
pipeline_tag: reinforcement-learning: This improves the model's discoverability on the Hugging Face Hub, allowing it to be found via the "Reinforcement Learning" filter. - Including the full paper title and a direct link to the Hugging Face paper page: Provides immediate context and easy access to the research.
- Adding the paper abstract: Offers a concise summary of the model's objectives and methodology.
- Explicitly linking to the GitHub repository: Ensures users can easily find the source code, further documentation, and active development.
- Integrating a detailed "Quickstart" section: This includes installation instructions, data/checkpoint download, and example commands for running and testing the model, directly sourced from the GitHub README to facilitate immediate usage.
- Embedding an overview image: Offers a visual representation of the model's architecture or problem scope.
- Adding the BibTeX citation: Enables proper academic attribution for users of RouteFinder.
- Including Acknowledgements and Known Bugs: Provides additional transparency and context from the original repository.
These changes make the model card more informative, user-friendly, and compliant with Hugging Face Hub best practices.