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 TrainerState doc because num_input_tokens_seen is unused by defau… #34593

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

techkang
Copy link
Contributor

@techkang techkang commented Nov 4, 2024

What does this PR do?

Fix #34567.
"include_num_input_tokens_seen argument is set to False by default, similar to load_best_model_at_end. However, the documentation for best_metric and best_model_checkpoint strongly implies that these two arguments will have no effect when the corresponding flag is not set. This PR makes the documentation consistent."

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

@Rocketknight1
Copy link
Member

cc @stevhliu!

Copy link
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 clarifying!

@stevhliu stevhliu merged commit bfa021b into huggingface:main Nov 4, 2024
9 checks passed
@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.

2015aroras pushed a commit to 2015aroras/transformers that referenced this pull request Nov 15, 2024
huggingface#34593)

fix TrainerState doc because num_input_tokens_seen is unused by default config

Co-authored-by: kangsheng <kangsheng@meituan.com>
BernardZach pushed a commit to BernardZach/transformers that referenced this pull request Dec 5, 2024
huggingface#34593)

fix TrainerState doc because num_input_tokens_seen is unused by default config

Co-authored-by: kangsheng <kangsheng@meituan.com>
BernardZach pushed a commit to innovationcore/transformers that referenced this pull request Dec 6, 2024
huggingface#34593)

fix TrainerState doc because num_input_tokens_seen is unused by default config

Co-authored-by: kangsheng <kangsheng@meituan.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.

TrainerState's property num_input_tokens_seen is not updating
4 participants
  NODES
COMMUNITY 3
innovation 1
Project 5
USERS 1