Improve model card: Add metadata, description, project page, and usage example

#1
by nielsr HF Staff - opened

This PR significantly enhances the model card by:

  • Adding pipeline_tag: visual-document-retrieval to the metadata for better discoverability on the Hub.
  • Adding library_name: aionsearch as the model is compatible with this library, enabling automated usage snippets.
  • Adding license: mit to clearly state the model's license.
  • Updating the model card's title and providing a concise description based on the paper.
  • Including direct links to the Hugging Face paper page, project page, demo, and related Hugging Face Datasets collection for comprehensive information.
  • Integrating a comprehensive "Quick Start" section, including installation instructions, requirements, and a Python code snippet directly from the original GitHub README, ensuring users can quickly get started with the model.
  • Adding the full BibTeX citation for proper academic attribution.
Ready to merge
This branch is ready to get merged automatically.

Sign up or log in to comment