Skip to content

docs: clarify recommended usage of max_new_tokens in generate() #42292

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −0
Open

docs: clarify recommended usage of max_new_tokens in generate() #42292

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/source/en/main_classes/text_generation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,8 @@ like token streaming.
[[autodoc]] GenerationMixin
- generate
- compute_transition_scores


> **Note**
Copy link
Member

@stevhliu stevhliu Nov 20, 2025

Choose a reason for hiding this comment

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

I think it's better to include the recommendation in the docstring here rather than adding it on as a note at the end.

> `max_new_tokens` is now the recommended argument to control how many tokens the model generates.
> `max_length` remains for backward compatibility because it includes the length of the input prompt, which can be less intuitive.