Skip to content

[docs]: update roformer.md model card#37946

Merged
stevhliu merged 7 commits intohuggingface:mainfrom
KsuParkhamchuk:roformer_model_card_update
May 23, 2025
Merged

[docs]: update roformer.md model card#37946
stevhliu merged 7 commits intohuggingface:mainfrom
KsuParkhamchuk:roformer_model_card_update

Conversation

@KsuParkhamchuk
Copy link
Copy Markdown
Contributor

What does this PR do?

Updates the RoFormer card according to the description in ##36979 to standardize all model cards' look.
The pr includes:

  • Model description
  • Examples for Pipeline, AutoModel, and command line usage

Note: Quantization is not applied because of the model's small size
Note: AttentionMaskVisualizer is not applicable either, as RoFormer is currently not supported

  • This PR improves the docs

Who can review?

@stevhliu Please have a look and let me know if any further work is needed. thank you

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2025

Hi 👋, thank you for opening this pull request! The pull request is converted to draft by default. The CI will be paused while the PR is in draft mode. When it is ready for review, please click the Ready for review button (at the bottom of the PR page). This will assign reviewers and trigger CI.

@github-actions github-actions Bot marked this pull request as draft May 4, 2025 00:55
@KsuParkhamchuk KsuParkhamchuk marked this pull request as ready for review May 4, 2025 01:00
@github-actions github-actions Bot requested a review from stevhliu May 4, 2025 01:00
Copy link
Copy Markdown
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.

Nice work, thanks for your contribution!

Comment thread docs/source/en/model_doc/roformer.md Outdated
Comment thread docs/source/en/model_doc/roformer.md Outdated
Comment thread docs/source/en/model_doc/roformer.md Outdated
Comment thread docs/source/en/model_doc/roformer.md Outdated
Comment thread docs/source/en/model_doc/roformer.md Outdated
Comment thread docs/source/en/model_doc/roformer.md Outdated
Comment thread docs/source/en/model_doc/roformer.md
Comment thread docs/source/en/model_doc/roformer.md
@KsuParkhamchuk
Copy link
Copy Markdown
Contributor Author

Thank you for the review @stevhliu ! The comments were addressed

Copy link
Copy Markdown
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, just a few more minor changes!

Comment thread docs/source/en/model_doc/roformer.md Outdated
Comment on lines -75 to -77
<frameworkcontent>
<pt>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You don't need to change the <frameworkcontent>, <pt> and <tf> tags either!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

moved them back

@KsuParkhamchuk
Copy link
Copy Markdown
Contributor Author

@stevhliu the latest comments are also fixed

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

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 merged commit 31f8a0f into huggingface:main May 23, 2025
10 checks passed
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