Skip to content

Updated processing_class docs for trainers #3737

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

Merged
merged 1 commit into from
Jul 16, 2025
Merged

Updated processing_class docs for trainers #3737

merged 1 commit into from
Jul 16, 2025

Conversation

sergiopaniego
Copy link
Member

What does this PR do?

Updated processing_class docs for trainers to also include BaseImageProcessor and the rest of possibilities.

Fixes # (issue)

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? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@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.

@sergiopaniego
Copy link
Member Author

I'm also considering spending a bit of time on the rest the trainer docs as in some places, you can see that some other classes are clickable while others aren't.
Example below where PretrainedModel is clickable (you go to its definition in one place but not the other).

Screenshot 2025-07-15 at 14 27 16

@qgallouedec
Copy link
Member

It seems like the doc is not getting uploaded...

@sergiopaniego
Copy link
Member Author

@qgallouedec it's working now!

Copy link
Member

@qgallouedec qgallouedec left a comment

Choose a reason for hiding this comment

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

For the record, the doc might not be correct in most case because VLM support is quite minimal in trl. But it's not the focus of this PR

Thanks @sergiopaniego !

@qgallouedec qgallouedec merged commit c8347b4 into main Jul 16, 2025
11 of 12 checks passed
@qgallouedec qgallouedec deleted the update-docs branch July 16, 2025 14:26
marcandrelarochelle pushed a commit to marcandrelarochelle/trl that referenced this pull request Jul 29, 2025
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