[ONNX] Improve docstrings and typing annotations #78231
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔗 Helpful links
✅ No Failures (0 Pending)As of commit fed901d (more details on the Dr. CI page): Expand to see more💚 💚 Looks good so far! There are no failures yet. 💚 💚 This comment was automatically generated by Dr. CI (expand for details).Please report bugs/suggestions to the (internal) Dr. CI Users group. |
justinchuby
added
module: onnx
BowenBao
reviewed
May 25, 2022
BowenBao
reviewed
May 25, 2022
|
A lot of CI failures, please take a look, maybe doc building is failing? |
2 tasks
…hu/onnx-docstrings
pytorchmergebot
pushed a commit
that referenced
this pull request
Jun 14, 2022
- Move definitions in `__init__` to internal classes and expose them by importing to init (prevent circular dependencies): https://github.com/pytorch/pytorch/wiki/torch.onnx-Namespacing - Context classes and enums are moved to `_exporter_states.py` - Exceptions are moved to `errors.py` - Define `__all__` for torch.onnx. https://github.com/pytorch/pytorch/wiki/Public-API-definition-and-documentation - Moved `utils.__IN_ONNX_EXPORT` to `GLOBALS.in_onnx_export` - Deprecated `torch.onnx._export` Precedes #78231 Using this as an aid for finding public functions: ```python list(filter(lambda x: not x.startswith("_"), torch.onnx.utils.__dict__.keys())) ``` Pull Request resolved: #78446 Approved by: https://github.com/BowenBao
BowenBao
approved these changes
Jun 15, 2022
|
@pytorchbot merge -g |
|
@pytorchbot successfully started a merge job. Check the current status here |
facebook-github-bot
pushed a commit
that referenced
this pull request
Jun 16, 2022
Summary: - Move definitions in `__init__` to internal classes and expose them by importing to init (prevent circular dependencies): https://github.com/pytorch/pytorch/wiki/torch.onnx-Namespacing - Context classes and enums are moved to `_exporter_states.py` - Exceptions are moved to `errors.py` - Define `__all__` for torch.onnx. https://github.com/pytorch/pytorch/wiki/Public-API-definition-and-documentation - Moved `utils.__IN_ONNX_EXPORT` to `GLOBALS.in_onnx_export` - Deprecated `torch.onnx._export` Precedes #78231 Using this as an aid for finding public functions: ```python list(filter(lambda x: not x.startswith("_"), torch.onnx.utils.__dict__.keys())) ``` Pull Request resolved: #78446 Approved by: https://github.com/BowenBao Test Plan: contbuild & OSS CI, see https://hud.pytorch.org/commit/pytorch/pytorch/d3ef5c3fa3ff677259a713b1b6533fa56e5f8ccc Reviewed By: malfet Differential Revision: D37156412 Pulled By: malfet fbshipit-source-id: 2d13f24c6a1e2c5d2636087c117fb77424500d78
|
Hey @justinchuby. |
justinchuby
added
release notes: onnx
facebook-github-bot
pushed a commit
that referenced
this pull request
Jun 20, 2022
Summary: - Remove wrappers in `__init__` around utils and instead expose those functions directly. Move the docstrings from `__init__` to corresponding functions in utils - Annotate `torch.onnx.export` types - Improve docstrings Pull Request resolved: #78231 Approved by: https://github.com/BowenBao Test Plan: contbuild & OSS CI, see https://hud.pytorch.org/commit/pytorch/pytorch/4b817f581640daf939fe9b195b1e8e7952c88203 Reviewed By: malfet Differential Revision: D37242157 Pulled By: malfet fbshipit-source-id: 24e8d55fc93a425a63f96deaa043963bad2e4984
justinchuby
added a commit
to justinchuby/pytorch
that referenced
this pull request
Jul 27, 2022
- Move definitions in `__init__` to internal classes and expose them by importing to init (prevent circular dependencies): https://github.com/pytorch/pytorch/wiki/torch.onnx-Namespacing - Context classes and enums are moved to `_exporter_states.py` - Exceptions are moved to `errors.py` - Define `__all__` for torch.onnx. https://github.com/pytorch/pytorch/wiki/Public-API-definition-and-documentation - Moved `utils.__IN_ONNX_EXPORT` to `GLOBALS.in_onnx_export` - Deprecated `torch.onnx._export` Precedes pytorch#78231 Using this as an aid for finding public functions: ```python list(filter(lambda x: not x.startswith("_"), torch.onnx.utils.__dict__.keys())) ``` Pull Request resolved: pytorch#78446 Approved by: https://github.com/BowenBao
justinchuby
added a commit
to justinchuby/pytorch
that referenced
this pull request
Jul 27, 2022
- Remove wrappers in `__init__` around utils and instead expose those functions directly. Move the docstrings from `__init__` to corresponding functions in utils - Annotate `torch.onnx.export` types - Improve docstrings Pull Request resolved: pytorch#78231 Approved by: https://github.com/BowenBao
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
__init__around utils and instead expose those functions directly. Move the docstrings from__init__to corresponding functions in utilstorch.onnx.exporttypes