Improve model card: Add pipeline tag, correct library_name, expand details, usage, and training info
#1
by
nielsr
HF Staff
- opened
This PR significantly enhances the model card for baartmar/DeepNSM-8B by:
- Adding
pipeline_tag: text-generationto the YAML metadata, ensuring the model is discoverable under the correct task filter on the Hugging Face Hub (e.g., at https://huggingface.co/models?pipeline_tag=text-generation). - Correcting
library_nametotransformersin the YAML metadata, astransformersis the primary library used for loading and performing inference with this model, rather thanpeftwhich was used for fine-tuning. - Adding relevant
tags(nlp,paraphrase,semantic-analysis,llama) to improve categorization and searchability. - Populating and expanding various sections with detailed information extracted from the paper abstract and the GitHub repository:
- Model Description: Provides a comprehensive overview of the model's purpose and the Natural Semantic Metalanguage (NSM) framework.
- Developed by: Includes the full list of authors.
- Model Sources: Adds a link to the Colab Demo, serving as a direct project page/demo.
- Uses: Clarifies direct and downstream applications, and outlines out-of-scope uses.
- Bias, Risks, and Limitations: Discusses potential issues such as language specificity, generative model characteristics, and resource requirements.
- How to Get Started with the Model: Includes a ready-to-use Python code snippet for inference using the
transformerslibrary. - Training Details: Provides specific training hyperparameters and links to the training dataset (
baartmar/nsm_dataset). - Evaluation: Summarizes the evaluation methodology and key results.
- Citation: Adds the BibTeX entry for the associated paper.
- Removing all
[More Information Needed]placeholders, making the model card complete and highly informative.
These updates aim to provide users with a much richer understanding and easier access to the model.