Improve model card: Add pipeline tag, library, description, and usage instructions

#1
by nielsr HF Staff - opened

This PR significantly improves the model card for the ConfTuner-Ministral model by:

  • Updating the model card's main title to reflect the paper: "ConfTuner: Training Large Language Models to Express Their Confidence Verbally".
  • Providing a comprehensive description based on the paper's abstract, filling in Model Details such as developed by, model type, and language.
  • Adding the pipeline_tag: text-generation to ensure the model is correctly categorized and discoverable on the Hugging Face Hub.
  • Setting library_name: transformers to indicate compatibility with the transformers library for inference, which is a standard for PEFT adapters based on Mistral.
  • Specifying license: other in the metadata and adding a note in the content, as no explicit license for the fine-tuned model weights was found.
  • Adding direct links to the paper (https://huggingface.co/papers/2508.18847) and the GitHub repository (https://github.com/liushiliushi/ConfTuner) for easy access to further information and code.
  • Populating the How to Get Started with the Model section with instructions on using the inference.py script, adhering strictly to the disclaimer of not creating code snippets not present in the original GitHub README.
  • Including detailed Training Details and Evaluation sections based on the GitHub README and paper.
  • Adding a correct BibTeX citation for the ConfTuner paper.
  • Updating Framework versions with PEFT and Transformers information.
liushiliushi changed pull request status to merged

Sign up or log in to comment