Improve model card: add metadata, links, and sample usage for DeEAR

#1
by nielsr HF Staff - opened

This PR significantly enhances the model card for the FreedomIntelligence/DeEAR_Base model by adding crucial metadata and detailed information.

Specifically, it:

  • Adds library_name: transformers metadata, as the config.json and preprocessor_config.json indicate compatibility and usage of transformers components (e.g., model_type: wav2vec2, Wav2Vec2FeatureExtractor). This enables the automated "how to use" widget on the model page.
  • Adds pipeline_tag: audio-classification to categorize the model for discovery on the Hugging Face Hub, reflecting its task of evaluating speech expressiveness.
  • Links to the official Hugging Face paper page: Decoding the Ear: A Framework for Objectifying Expressiveness from Human Preference Through Efficient Alignment.
  • Provides a link to the project page: https://freedomintelligence.github.io/ExpressiveSpeech/.
  • Includes a link to the GitHub repository: https://github.com/FreedomIntelligence/ExpressiveSpeech.
  • Integrates a comprehensive "Introduction", "Key Features", and "Framework Overview" directly from the GitHub README to better describe the model.
  • Incorporates a "Sample Usage" section with code snippets directly from the GitHub README's "Quick Start" guide, enabling users to quickly get started with inference.
  • Adds the BibTeX citation for proper academic attribution.

These updates aim to make the model more discoverable, easier to understand, and more user-friendly on the Hugging Face Hub.

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

Sign up or log in to comment