Skip to content
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

[docs] Model docs #36469

Merged
merged 11 commits into from
Mar 21, 2025
Merged

[docs] Model docs #36469

merged 11 commits into from
Mar 21, 2025

Conversation

stevhliu
Copy link
Member

🚧 WIP 🚧

Explores a new design for several of the most commonly visited model docs. It is pretty stripped down at the moment, but we can add back the essentials as needed (or not). The main idea is to only show developers what they need to know to use the model.

  • A badge indicating whether a model supports certain features/frameworks (PyTorch, SDPA, FlashAttention, etc.) in the upper right side of the doc.
  • A brief description of the model and what makes it different. Some of these abstracts just don't tell you that much about the model itself or what makes it unique, while others are very technical and the details probably don't matter that much if you aren't a researcher. The description aims for somewhere in between.
  • Code snippets demonstrating inference with all the optimizations included.

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@stevhliu stevhliu force-pushed the model-doc-design branch 3 times, most recently from f353e9e to 8416e96 Compare March 14, 2025 21:37
Copy link
Collaborator

@ArthurZucker ArthurZucker left a comment

Choose a reason for hiding this comment

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

Very nice thanks! Image should be on the hub I think but LGTM

@stevhliu stevhliu marked this pull request as ready for review March 20, 2025 23:15
@stevhliu stevhliu force-pushed the model-doc-design branch 2 times, most recently from 9a3e0ca to 3d2a172 Compare March 21, 2025 18:22
@stevhliu stevhliu merged commit d253de6 into huggingface:main Mar 21, 2025
10 checks passed
@stevhliu stevhliu deleted the model-doc-design branch March 21, 2025 22:35
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.

3 participants