Improve model card for ReVerT (Think, Verbalize, then Speak)

#1
by nielsr HF Staff - opened

This PR significantly enhances the model card for the revert-Qwen2.5-3B model by:

  • Adding pipeline_tag: text-generation to the metadata for better discoverability, correctly classifying the model as a verbalizer for speech-ready text.
  • Populating the model description with details from the paper abstract and the project's GitHub README.
  • Including direct links to the paper (Think, Verbalize, then Speak: Bridging Complex Thoughts and Comprehensible Speech), the official project page (https://yhytoto12.github.io/TVS-ReVerT), and the GitHub repository (https://github.com/yhytoto12/TVS-ReVerT).
  • Adding the "News" section directly from the GitHub README to provide recent updates.
  • Providing a "How to Get Started" section with the bash code snippets for the interactive demo, as explicitly found in the GitHub README, without making up custom Python code.
  • Adding details about the training datasets and procedure, extracted from the GitHub repository.
  • Including the framework image from the GitHub README for better visual context.
  • Incorporating the BibTeX citation provided in the paper's repository.
  • Setting license: other in the metadata and noting the lack of an explicit license in the content, adhering to best practices when no direct license is stated.

These updates provide comprehensive information, making the model card more informative and user-friendly for the Hugging Face community.

Thank you for the PR!

yhytoto12 changed pull request status to merged

Sign up or log in to comment