Improve model card: add pipeline tag, detailed metrics, description, and usage

by nielsr HF Staff - opened Jul 18

base: refs/heads/main

←

from: refs/pr/1

Discussion Files changed

+106

-15

nielsr

Jul 18

This pull request significantly enhances the model card for mdeberta-v3-base-subjectivity-english by:

Updating Metadata:
- Adding pipeline_tag: text-classification for improved discoverability on the Hugging Face Hub.
- Correcting the license to cc-by-4.0 as specified in the project's GitHub repository.
- Adding more specific tags like subjectivity-detection and news-articles to better describe the model's domain and task.
- Populating the model-index with detailed evaluation metrics for better presentation and comparison on the Hub.
Enriching Content:
- Removing the auto-generated model card comment.
- Providing comprehensive details in the "Model description", "Intended uses & limitations", and "Training and evaluation data" sections, drawing information from the paper abstract and the GitHub README.
- Adding a clear "How to use" section with a transformers.pipeline code snippet for easy model inference.
- Including a direct link to the project's GitHub repository under a new "Code" section.
- Adding a "Citation" section with the relevant BibTeX entry for the paper.

These changes provide a more complete, accurate, and user-friendly model card, aligning with Hugging Face Hub best practices.

Improve model card: add pipeline tag, detailed metrics, description, and usagea0b80613

Update bibtex citation section637ccdc5

MatteoFasulo

Owner Jul 18

This pull request significantly enhances the model card for mdeberta-v3-base-subjectivity-english by:

Updating Metadata:

Adding pipeline_tag: text-classification for improved discoverability on the Hugging Face Hub.

Correcting the license to cc-by-4.0 as specified in the project's GitHub repository.

Adding more specific tags like subjectivity-detection and news-articles to better describe the model's domain and task.

Populating the model-index with detailed evaluation metrics for better presentation and comparison on the Hub.

Enriching Content:

Removing the auto-generated model card comment.

Providing comprehensive details in the "Model description", "Intended uses & limitations", and "Training and evaluation data" sections, drawing information from the paper abstract and the GitHub README.

Adding a clear "How to use" section with a transformers.pipeline code snippet for easy model inference.

Including a direct link to the project's GitHub repository under a new "Code" section.

Adding a "Citation" section with the relevant BibTeX entry for the paper.

These changes provide a more complete, accurate, and user-friendly model card, aligning with Hugging Face Hub best practices.

Hi @nielsr , thank you for the PR! I added the correct bibtex citation in the README.

MatteoFasulo changed pull request status to merged Jul 18

Upload images, audio, and videos by dragging in the text input, pasting, or clicking here.

Tap or paste here to upload images

· Sign up or log in to comment