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

Fix typo in max_length deprecation warnings #27788

Merged
merged 1 commit into from
Dec 4, 2023

Conversation

siegeln
Copy link
Contributor

@siegeln siegeln commented Dec 1, 2023

What does this PR do?

Specifying the max_length parameter in some text generation functions results in a deprecation warning. Currently, these warnings say to fix by using stopping_criteria=StoppingCriteriaList(MaxLengthCriteria(max_length=max_length)); however, this results in the error TypeError: 'MaxLengthCriteria' object is not iterable, as StoppingCriteriaList expects an iterable.

This PR fixes this typo.

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?

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.

Copy link
Collaborator

@ArthurZucker ArthurZucker left a comment

Choose a reason for hiding this comment

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

Thanks! cc @gante pretty sure we can remove the warning no? max_length is as convenient as max_new_tokens IMO? 😉

Copy link
Member

@gante gante left a comment

Choose a reason for hiding this comment

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

Thank you for the fix!

@gante
Copy link
Member

gante commented Dec 1, 2023

@ArthurZucker in this case they are not interchangeable, MaxLengthCriteria expects max_length. In generate, max_new_tokens is converted into its max_length equivalent before MaxLengthCriteria is initialized :)

@ArthurZucker
Copy link
Collaborator

Ah right! Missed that, thanks 😉

@ArthurZucker ArthurZucker merged commit a2b1e1d into huggingface:main Dec 4, 2023
21 checks passed
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

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