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 type hint for train_dataset param of Trainer.__init__() to allow IterableDataset. Issue 29678 #29738

Merged
merged 3 commits into from
Mar 22, 2024

Conversation

stevemadere
Copy link
Contributor

@stevemadere stevemadere commented Mar 19, 2024

Prevents introducing confusion for developers using PyRight and other type checking
systems when they try to use Trainer.train() as documented with an IterableDataset
for training.

No new dependencies.

Fixes #29678

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?

@muellerzr , @pacman100

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

Copy link
Collaborator

@amyeroberts amyeroberts 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 adding!

The failing test is unrelated to this PR - there was a fix pushed to main, could you try rebasing to include this update?

Copy link
Contributor

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

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

Thanks! Agreed, we can merge once the ci is fully green (unrelated to you though)

@amyeroberts amyeroberts merged commit 3479161 into huggingface:main Mar 22, 2024
21 checks passed
itazap pushed a commit that referenced this pull request May 14, 2024
…IterableDataset. Issue 29678 (#29738)

* Fixed typehint for train_dataset param in Trainer.__init__().  Added IterableDataset option.

* make fixup
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.

Type annotation for train_dataset and eval_dataset params of Trainer incompatible with IterableDataset
4 participants