Improve model card: Add pipeline tag, paper, code, abstract, quantitative results, sample usage, and visualizations

#4
by nielsr HF Staff - opened

This PR significantly enhances the model card for the SimVQ model by incorporating comprehensive details from the paper and its official GitHub repository.

Key changes include:

  • Adding the pipeline_tag: image-to-image to improve discoverability for image-related tasks on the Hugging Face Hub.
  • Including direct links to the paper and the GitHub repository for easy access to research and code.
  • Providing an introduction and algorithm overview, based on the paper's abstract, to explain the model's innovation.
  • Adding quantitative comparison tables that showcase SimVQ's performance on both image (ImageNet) and audio (LibriTTS) tasks, along with links to checkpoints.
  • Incorporating sample usage instructions, including installation, training, and evaluation scripts, directly from the GitHub README.
  • Adding reconstruction visualizations for both image and audio to visually demonstrate the model's capabilities.
  • Including acknowledgement and citation sections for proper attribution.

These updates aim to make the model card more informative, accessible, and aligned with Hugging Face Hub best practices.

Ready to merge
This branch is ready to get merged automatically.

Sign up or log in to comment