Skip to content

Standardize RAG model card #40222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

aayush226
Copy link

@aayush226 aayush226 commented Aug 16, 2025

What does this PR do?

This PR updates rag.md to follow the new Hugging Face model card template.

What & why

  • Add friendly overview written for new users
  • Add AutoModel usage examples
  • Include a quantization snippet with BitsAndBytesConfig

Scope

  • Docs only: docs/source/en/model_doc/rag.md
  • Autodoc/API sections are unchanged as mentioned in the guidelines

Related

Before submitting

Who can review?

@stevhliu

Update rag.md to follow the new Hugging Face model card template:
- Added friendly overview in plain language
- Added pipeline and AutoModel usage examples
- Included quantization example with BitsAndBytesConfig
- Added notes and resources sections
- Removed abstract and FlashAttention badge
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your work!

@aayush226
Copy link
Author

Hi @stevhliu! Thank you for taking the time to provide such a detailed feedback. I have incorporated everything you have mentioned. Can you please take another look at my changes? Thank you.

Update rag.md to follow the new Hugging Face model card template:
- Added friendly overview in plain language
- Added AutoModel usage example
- Included quantization example with BitsAndBytesConfig
@aayush226 aayush226 force-pushed the docs/rag-standardization branch from 4d222a9 to 08b7bbb Compare August 19, 2025 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants