Skip to content

Standardize ByT5 model card format#38699

Merged
stevhliu merged 5 commits intohuggingface:mainfrom
yanamis:update-byt5-model-card
Jun 9, 2025
Merged

Standardize ByT5 model card format#38699
stevhliu merged 5 commits intohuggingface:mainfrom
yanamis:update-byt5-model-card

Conversation

@yanamis
Copy link
Copy Markdown
Contributor

@yanamis yanamis commented Jun 9, 2025

What does this PR do?

This PR updates the ByT5 model card to follow the standardized format as requested in #36979.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

@stevhliu

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 for contributing!

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

yanamis commented Jun 9, 2025

Thanks @stevhliu for the detailed feedback! I've updated the model card as suggested. Please let me know if anything else needs adjusting.

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.

Just a few more comments and then we can merge :)

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

yanamis commented Jun 9, 2025

Everything's done now. Thanks again for your help :)

@stevhliu stevhliu force-pushed the update-byt5-model-card branch from 4582b1b to 9011011 Compare June 9, 2025 20:13
@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
Copy link
Copy Markdown
Member

stevhliu commented Jun 9, 2025

Can you try running make repo-consistency from the command line to fix the check_repository_consistency job?

ydshieh and others added 2 commits June 9, 2025 23:09
* fix 1: load_in_4bit=True,

* fix 2: decorateor

* fixfix 2: breakpoint

* fixfix 3: update

* fixfix 4: fast

* fixfix 5: cond

* fixfix 5: cond

* fixfix 6: cuda 8

* ruff

* breakpoint

* dtype

* a10

* a10

---------

Co-authored-by: ydshieh <ydshieh@users.noreply.github.com>
@yanamis
Copy link
Copy Markdown
Contributor Author

yanamis commented Jun 9, 2025

I've rebased the branch to bring it up to date and pushed the fix for the repo check error. Please let me know if it's all good now :)

@stevhliu stevhliu merged commit 81799d8 into huggingface:main Jun 9, 2025
15 checks passed
stevhliu added a commit that referenced this pull request Jun 9, 2025
bvantuan pushed a commit to bvantuan/transformers that referenced this pull request Jun 12, 2025
* Standardize ByT5 model card format

* Apply review feedback from @stevhliu

* Fix Notes formatting and wording

* Fix `aya_vision` test (huggingface#38674)

* fix 1: load_in_4bit=True,

* fix 2: decorateor

* fixfix 2: breakpoint

* fixfix 3: update

* fixfix 4: fast

* fixfix 5: cond

* fixfix 5: cond

* fixfix 6: cuda 8

* ruff

* breakpoint

* dtype

* a10

* a10

---------

Co-authored-by: ydshieh <ydshieh@users.noreply.github.com>

* Fix autodoc formatting for ByT5Tokenizer

---------

Co-authored-by: Yih-Dar <2521628+ydshieh@users.noreply.github.com>
Co-authored-by: ydshieh <ydshieh@users.noreply.github.com>
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.

4 participants