Update CTRL model card with improved usage examples and documentation notes #39487
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
• Added <hfoptions> section with structured transformers-cli and transformers.js usage examples • Ensured proper opening and closing of <hfoption> and <hfoptions> tags • Added detailed Notes and Resources sections • Clarified control code usage and limitations for CTRL model • Mentioned lack of attention visualization compatibility This brings the model card for ctrl in line with Hugging Face model card standards for clarity, interactivity, and completeness.
…ohole/transformers into update-ctrl-model-card
|
Hi, please check my post here for the expected format! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR improves the ctrl model card to align with Hugging Face documentation standards and improve clarity for users. Specifically, it:
• Updates metadata fields (e.g., license, tags, library name, model type)
• Improves model description for better readability
• Adds usage tips and clearer links to paper and code
• Enhances tokenizer and limitations sections
• Fixes minor formatting inconsistencies
These changes ensure consistency with other official model cards and improve user understanding when exploring or deploying the ctrl model.
⸻
What does this PR do?
✔️ Updates and standardizes the ctrl model card
✔️ Improves clarity, formatting, and metadata fields
✔️ Enhances user experience and aligns with documentation best practices
⸻
Before submitting
• I’ve read the Pull Request section of the contributing guide
• Documentation has been updated accordingly
• No new tests are necessary (doc-only PR)
⸻
Who can review?
Anyone in the community is welcome to review.
Recommended reviewers: @stevhliu