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

[Refactor] Make @tensorclass work properly with pyright #1042

Merged
merged 3 commits into from
Oct 16, 2024

Conversation

Mxbonn
Copy link
Contributor

@Mxbonn Mxbonn commented Oct 15, 2024

Description

Describe your changes in detail.

Motivation and Context

@tensorclass() # works without typing issues
class MyClass:
    a = torch.Tensor
    b = torch.Tensor
    
@tensorclass # results in pyright typing issues and is arguably more commonly used than @tensorclass() with parentheses
class MyClass:
    a = torch.Tensor
    b = torch.Tensor

pyright: error:

Argument of type "type[MyClass]" cannot be assigned to parameter "autocast" of type "bool" in function "__new__"
  "type[type]" is not assignable to "type[bool]"Pylance[reportArgumentType](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#reportArgumentType)

Types of changes

I looked at the @dataclass implementation and mimicked the behavior here. I'm no expert in typing.

  • typing change

Potential breaking change:
Technically you could have used @tensordict the following:
@tensordict(<bool_for_autocast_without_using_the_keyword>)
or
@tensordict(<bool_for_autocast_without_using_the_keyword>, <bool_for_frozen_without_using_the_keyword>)

This will break now but I doubt any sane person uses it like that, cs.github.com did not show any such usage when I looked for it.

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

@facebook-github-bot
Copy link

Hi @Mxbonn!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 15, 2024
@vmoens vmoens changed the title Make @tensorclass work properly with pyright [Refactor] Make @tensorclass work properly with pyright Oct 16, 2024
@vmoens vmoens added the Refactor Refactoring code - not a new feature label Oct 16, 2024
@vmoens vmoens merged commit fe6db77 into pytorch:main Oct 16, 2024
26 of 32 checks passed
@Mxbonn Mxbonn deleted the fix/typing branch October 16, 2024 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. Refactor Refactoring code - not a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants