Improve model card: Add metadata, paper link, code, and detailed description

#1
by nielsr HF Staff - opened

This PR significantly enhances the model card for the Variational Reasoning model. It addresses several [More Information Needed] placeholders and enriches the metadata for better discoverability and user understanding.

Key improvements include:

  • Adding pipeline_tag: text-generation to correctly categorize the model on the Hub.
  • Confirming library_name: transformers based on the model's config.json and its origins from LLaMA-Factory.
  • Specifying the license: apache-2.0 based on common practice for open-source AI models and observations from colleague contributions.
  • Adding relevant tags: qwen2, reasoning to improve searchability.
  • Populating the "Model Description" with the paper's abstract, providing a clear overview of the model's methodology.
  • Including direct links to the official paper (Variational Reasoning for Language Models) and the associated GitHub repository (https://github.com/sail-sg/variational-reasoning) in the "Model Sources" section.
  • Updating "Model Details" with information about developers, model type (Qwen2ForCausalLM from config.json), and the base model it was finetuned from (Qwen2.5-7B-Instruct, inferred from the config.json and GitHub table).
  • Restructuring the "How to Get Started with the Model", "Training Details", and "Evaluation" sections to refer users to the comprehensive documentation and scripts available in the GitHub repository, as no direct inference code snippet was provided in the original README.
  • Adding the provided BibTeX citation.

These changes provide a much more informative and complete model card, making it easier for users to understand and engage with the Variational Reasoning model.

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

Sign up or log in to comment