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 return type annotation to PreTrainedModel.from_pretrained #31869

Merged

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Jul 9, 2024

What does this PR do?

As the title says, this adds the return type annotation to PreTrainedModel.from_pretrained. This is necessary so that pytorch-lightning's LightningCLI is able to make automatically configurable transformer models.

Fixes #31850

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.

@amyeroberts please review.

Add return type annotation to PreTrainedModel.from_pretrained
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!

@amyeroberts amyeroberts merged commit c5bc2d5 into huggingface:main Jul 9, 2024
20 checks passed
@mauvilsa mauvilsa deleted the model-from-pretrained-return-type branch July 10, 2024 09:37
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.

Return type annotation for PretrainedConfig.from_pretrained wrong?
2 participants