Improve model card with metadata and additional usage information

#2
by nielsr HF Staff - opened

This PR enhances the model card for Goedel-Prover-V2 by:

  • Adding pipeline_tag: text-generation to the metadata: This ensures the model is correctly categorized on the Hugging Face Hub, improving its discoverability and enabling the proper inference widget for text generation tasks.
  • Adding library_name: transformers to the metadata: This indicates that the model is compatible with the transformers library, ensuring users see the correct "how to use" code snippets.
  • Replacing HTML badges with cleaner Markdown badges: The existing inline HTML for badges has been replaced with standard Markdown badge syntax from the project's GitHub README, improving the model card's structure and rendering. The GitHub code link, project website, and arXiv paper link are all correctly included.
  • Including "Environment Setup" and "Batch Inference and Self-correction" sections: These sections, present in the project's GitHub README but missing from the current model card, provide crucial information for setting up the Lean 4 environment and performing batch inference, significantly improving the user experience.
  • Removing extraneous "File information": As per guidelines, internal file information has been removed from the public model card.

These updates aim to make the Goedel-Prover-V2 model card more informative, user-friendly, and compliant with Hugging Face Hub best practices.

Bohan22 changed pull request status to merged

Sign up or log in to comment