Improve model card: Add library name, key features, and usage example

#1
by nielsr HF Staff - opened

This PR significantly enhances the model card by:

  • Adding library_name: transformers to the metadata. This enables the "How to use" widget on the Hugging Face Hub, making the model more discoverable and user-friendly with direct code examples.
  • Expanding the model card's content to provide a comprehensive overview. This includes:
    • An introduction summarizing the model's purpose, derived from the paper's abstract.
    • Detailed "Key Features" explaining the core contributions of the SENTINEL framework.
    • A practical Python code snippet for loading and inferring with the model using transformers and peft.
    • Information about the associated SENTINEL Dataset.
    • A section for Acknowledgement to credit related projects.
    • The Citation information for proper attribution.

These improvements draw directly from the rich information available in the project's GitHub repository, ensuring the Hugging Face Hub page serves as a primary source of information for researchers and developers.

Thanks a lot!

psp-dada changed pull request status to closed

Sign up or log in to comment