[2/3] Update `.pyi` Python stub files: Prettify `rnn.py` by using type annotated `NamedTuple` #95267

XuehaiPan · 2023-02-22T04:33:40Z

Changes:

[1/3] Recognize .py.in and .pyi.in files as Python in VS Code #95200

Recognize .py.in and .pyi.in files as Python in VS Code for a better development experience.
Fix deep setting merge in tools/vscode_settings.py.

=> this PR: [2/3] Update .pyi Python stub files: Prettify rnn.py by using type annotated NamedTuple #95267

Use Namedtuple rather than namedtuple + __annotations__ for torch.nn.utils.rnn.PackedSequence_:

namedtuple + __annotations__:

PackedSequence_ = namedtuple('PackedSequence_',
                             ['data', 'batch_sizes', 'sorted_indices', 'unsorted_indices'])

# type annotation for PackedSequence_ to make it compatible with TorchScript
PackedSequence_.__annotations__ = {'data': torch.Tensor, 'batch_sizes': torch.Tensor,
                                   'sorted_indices': Optional[torch.Tensor],
                                   'unsorted_indices': Optional[torch.Tensor]}

Namedtuple: Python 3.6+

class PackedSequence_(NamedTuple):
    data: torch.Tensor
    batch_sizes: torch.Tensor
    sorted_indices: Optional[torch.Tensor]
    unsorted_indices: Optional[torch.Tensor]

[3/3] Update .pyi Python stub files and enable 'UFMT' linter #95268

Sort import statements and remove unnecessary imports in .pyi, .pyi.in files.
Format .pyi, .pyi.in files and remove unnecessary ellipsis ... in type stubs.

pytorch-bot · 2023-02-22T04:33:42Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/95267

📄 Preview Python docs built from this PR
📄 Preview C++ docs built from this PR
❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit d3ab646:
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

torch/ao/nn/quantized/dynamic/modules/rnn.py

torch/nn/utils/rnn.py

janeyx99

Could you update the PR title to explain what this does? Something like
"Prettify rnn.py by using type annotated NamedTuple"

janeyx99 · 2023-03-01T15:44:39Z

Feel free to land this PR whenever you are ready

XuehaiPan · 2023-03-01T15:50:22Z

@pytorchbot merge

pytorchmergebot · 2023-03-01T15:53:48Z

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

…5200) Changes: - => this PR: #95200 1. Recognize `.py.in` and `.pyi.in` files as Python in VS Code for a better development experience. 2. Fix deep setting merge in `tools/vscode_settings.py`. - #95267 3. Use `Namedtuple` rather than `namedtuple + __annotations__` for `torch.nn.utils.rnn.PackedSequence_`: `namedtuple + __annotations__`: ```python PackedSequence_ = namedtuple('PackedSequence_', ['data', 'batch_sizes', 'sorted_indices', 'unsorted_indices']) # type annotation for PackedSequence_ to make it compatible with TorchScript PackedSequence_.__annotations__ = {'data': torch.Tensor, 'batch_sizes': torch.Tensor, 'sorted_indices': Optional[torch.Tensor], 'unsorted_indices': Optional[torch.Tensor]} ``` `Namedtuple`: Python 3.6+ ```python class PackedSequence_(NamedTuple): data: torch.Tensor batch_sizes: torch.Tensor sorted_indices: Optional[torch.Tensor] unsorted_indices: Optional[torch.Tensor] ``` - #95268 4. Sort import statements and remove unnecessary imports in `.pyi`, `.pyi.in` files. 5. Format `.pyi`, `.pyi.in` files and remove unnecessary ellipsis `...` in type stubs. Pull Request resolved: #95200 Approved by: https://github.com/janeyx99

) Changes: - #95200 1. Recognize `.py.in` and `.pyi.in` files as Python in VS Code for a better development experience. 2. Fix deep setting merge in `tools/vscode_settings.py`. - #95267 3. Use `Namedtuple` rather than `namedtuple + __annotations__` for `torch.nn.utils.rnn.PackedSequence_`: `namedtuple + __annotations__`: ```python PackedSequence_ = namedtuple('PackedSequence_', ['data', 'batch_sizes', 'sorted_indices', 'unsorted_indices']) # type annotation for PackedSequence_ to make it compatible with TorchScript PackedSequence_.__annotations__ = {'data': torch.Tensor, 'batch_sizes': torch.Tensor, 'sorted_indices': Optional[torch.Tensor], 'unsorted_indices': Optional[torch.Tensor]} ``` `Namedtuple`: Python 3.6+ ```python class PackedSequence_(NamedTuple): data: torch.Tensor batch_sizes: torch.Tensor sorted_indices: Optional[torch.Tensor] unsorted_indices: Optional[torch.Tensor] ``` - => this PR: #95268 4. Sort import statements and remove unnecessary imports in `.pyi`, `.pyi.in` files. 5. Format `.pyi`, `.pyi.in` files and remove unnecessary ellipsis `...` in type stubs. Pull Request resolved: #95268 Approved by: https://github.com/huydhn

…e annotated `NamedTuple` (#95267) Changes: - #95200 1. Recognize `.py.in` and `.pyi.in` files as Python in VS Code for a better development experience. 2. Fix deep setting merge in `tools/vscode_settings.py`. - => this PR: #95267 3. Use `Namedtuple` rather than `namedtuple + __annotations__` for `torch.nn.utils.rnn.PackedSequence_`: `namedtuple + __annotations__`: ```python PackedSequence_ = namedtuple('PackedSequence_', ['data', 'batch_sizes', 'sorted_indices', 'unsorted_indices']) # type annotation for PackedSequence_ to make it compatible with TorchScript PackedSequence_.__annotations__ = {'data': torch.Tensor, 'batch_sizes': torch.Tensor, 'sorted_indices': Optional[torch.Tensor], 'unsorted_indices': Optional[torch.Tensor]} ``` `Namedtuple`: Python 3.6+ ```python class PackedSequence_(NamedTuple): data: torch.Tensor batch_sizes: torch.Tensor sorted_indices: Optional[torch.Tensor] unsorted_indices: Optional[torch.Tensor] ``` - #95268 4. Sort import statements and remove unnecessary imports in `.pyi`, `.pyi.in` files. 5. Format `.pyi`, `.pyi.in` files and remove unnecessary ellipsis `...` in type stubs. Pull Request resolved: pytorch/pytorch#95267 Approved by: https://github.com/janeyx99

…sing type annotated `NamedTuple` (pytorch#95267)" This reverts commit ef731cd.

XuehaiPan requested review from albanD and jbschlosser as code owners February 22, 2023 04:33

pytorch-bot bot added the release notes: AO frontend label Feb 22, 2023

This was referenced Feb 22, 2023

[1/3] Recognize .py.in and .pyi.in files as Python in VS Code #95200

Closed

[3/3] Update .pyi Python stub files and enable 'UFMT' linter #95268

Closed

pytorchbot added the open source label Feb 22, 2023

Use typing.NamedTuple in torch.uu.utils.rnn

02406be

XuehaiPan force-pushed the packedseq-namedtuple branch from 4310cc0 to 02406be Compare February 22, 2023 05:32

bdhirsh added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label Feb 22, 2023

janeyx99 reviewed Feb 28, 2023

View reviewed changes

torch/ao/nn/quantized/dynamic/modules/rnn.py Outdated Show resolved Hide resolved

janeyx99 reviewed Feb 28, 2023

View reviewed changes

torch/nn/utils/rnn.py Show resolved Hide resolved

janeyx99 reviewed Feb 28, 2023

View reviewed changes

janeyx99 added the topic: not user facing topic category label Feb 28, 2023

XuehaiPan changed the title ~~[2/3] Update .pyi Python stub files and recognize .py.in and .pyi.in files as Python in VS Code~~ [2/3] Update .pyi Python stub files: Prettify rnn.py by using type annotated NamedTuple Mar 1, 2023

XuehaiPan added 2 commits March 1, 2023 05:21

Apply suggestions from code review

f306592

Merge branch 'master' into packedseq-namedtuple

d3ab646

janeyx99 approved these changes Mar 1, 2023

View reviewed changes

pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Mar 1, 2023

pytorchmergebot added the Merged label Mar 1, 2023

pytorchmergebot closed this in ef731cd Mar 1, 2023

XuehaiPan deleted the packedseq-namedtuple branch March 2, 2023 06:51

pruthvistony added a commit to ROCm/pytorch that referenced this pull request May 2, 2023

Revert "[2/3] Update .pyi Python stub files: Prettify rnn.py by u…

30bc85f

…sing type annotated `NamedTuple` (pytorch#95267)" This reverts commit ef731cd.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[2/3] Update `.pyi` Python stub files: Prettify `rnn.py` by using type annotated `NamedTuple` #95267

[2/3] Update `.pyi` Python stub files: Prettify `rnn.py` by using type annotated `NamedTuple` #95267

Uh oh!

XuehaiPan commented Feb 22, 2023 •

edited

Loading

Uh oh!

pytorch-bot bot commented Feb 22, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

janeyx99 left a comment

Uh oh!

janeyx99 commented Mar 1, 2023

Uh oh!

XuehaiPan commented Mar 1, 2023

Uh oh!

pytorchmergebot commented Mar 1, 2023

Uh oh!

Uh oh!

[2/3] Update .pyi Python stub files: Prettify rnn.py by using type annotated NamedTuple #95267

[2/3] Update .pyi Python stub files: Prettify rnn.py by using type annotated NamedTuple #95267

Uh oh!

Conversation

XuehaiPan commented Feb 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Feb 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/95267

✅ No Failures

Uh oh!

Uh oh!

Uh oh!

janeyx99 left a comment

Choose a reason for hiding this comment

Uh oh!

janeyx99 commented Mar 1, 2023

Uh oh!

XuehaiPan commented Mar 1, 2023

Uh oh!

pytorchmergebot commented Mar 1, 2023

Merge started

Uh oh!

Uh oh!

[2/3] Update `.pyi` Python stub files: Prettify `rnn.py` by using type annotated `NamedTuple` #95267

[2/3] Update `.pyi` Python stub files: Prettify `rnn.py` by using type annotated `NamedTuple` #95267

XuehaiPan commented Feb 22, 2023 •

edited

Loading

pytorch-bot bot commented Feb 22, 2023 •

edited

Loading