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

👈 Add tokenizer arg back and add deprecation guidelines #2348

Merged
merged 3 commits into from
Nov 11, 2024

Conversation

qgallouedec
Copy link
Member

@qgallouedec qgallouedec commented Nov 11, 2024

What does this PR do?

#2162 introduced a breaking change on all trainers except DPO and SFT (tokenizer arg replaced by processing_class). We've had feedback that this change was too abrupt, so we're reintroducing this argument with an extended timeline for its removal and also clarifying our removal strategy.

This PR will be part of a patch release for v0.12

Here is the proposed schedule depending of the usage for each trainer:

Trainer Num models on the Hub Argument removed in version
SFT 15,097 0.16
DPO 3,053 0.16
PPO 441 0.15
ORPO 320 0.15
Reward 270 0.15
KTO 80 0.14
CPO 26 0.14
Online DPO 14 0.14
RLOO 4 0.14
XPO 3 0.13
Nash 1 0.13
GKD 1 0.13
Iterative SFT 1 0.13
BCO 0 0.13

cc @muellerzr

Related: #2290 #2226 #2207 #2218

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? Here are the
    documentation guidelines.
  • 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.

@qgallouedec qgallouedec marked this pull request as ready for review November 11, 2024 21:21
@qgallouedec qgallouedec changed the title 👈 Add tokenizer arg back and deprecation and backward compatibility guidelines 👈 Add tokenizer arg back and add deprecation guidelines Nov 11, 2024
Copy link
Member

@lewtun lewtun left a comment

Choose a reason for hiding this comment

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

Thanks a lot for enabling backwards compatibility @qgallouedec! The PR LGTM and the new docs are really well written 🔥

@@ -256,3 +256,30 @@ That's how `make test` is implemented (without the `pip install` line)!

You can specify a smaller set of tests to test only the feature
you're working on.

### Deprecation and Backward Compatibility
Copy link
Member

Choose a reason for hiding this comment

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

Super nice documentation!

CONTRIBUTING.md Show resolved Hide resolved
@muellerzr
Copy link
Contributor

Beautiful! 🔥

@qgallouedec qgallouedec merged commit 015321e into main Nov 11, 2024
14 checks passed
@qgallouedec qgallouedec deleted the tokenizer-back branch November 11, 2024 23:06
qgallouedec added a commit that referenced this pull request Nov 11, 2024
* Add deprecation and backward compatibility guidelines

* Update tokenizer argument in trainer classes

* Add warning message for TRL Judges API
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.

5 participants