Skip to content

[ONNX] Improves documentation of ONNX exporter#135372

Closed
xadupre wants to merge 5 commits intopytorch:mainfrom
xadupre:onnxdocs
Closed

[ONNX] Improves documentation of ONNX exporter#135372
xadupre wants to merge 5 commits intopytorch:mainfrom
xadupre:onnxdocs

Conversation

@xadupre
Copy link
Collaborator

@xadupre xadupre commented Sep 6, 2024

The PR updates the documentation to reflect the changes introduced in pytorch 2.5 and related to onnx exporter.

@pytorch-bot
Copy link

pytorch-bot bot commented Sep 6, 2024 •
edited
Loading

🔗 Helpful Links

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

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

✅ No Failures

As of commit 4fecb3f with merge base 24482e5 (image):
💚 Looks good so far! There are no failures yet. 💚

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

@pytorch-bot pytorch-bot bot added the release notes: onnx torch.onnx related changes that should show up in the release notes label Sep 6, 2024
justinchuby
justinchuby approved these changes Sep 6, 2024
View reviewed changes
Copy link
Collaborator

@justinchuby justinchuby left a comment

Choose a reason for hiding this comment

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

Thanks!

torch/onnx/__init__.py Outdated
Comment on lines +292 to +294
:func:`torch.export.export` for more details. This is only used when dynamo is True.
Only one parameter `dynamic_axes` or `dynamic_shapes` should be set
at the same time.
Copy link
Collaborator

@justinchuby justinchuby Sep 6, 2024

Choose a reason for hiding this comment

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

Thanks! I was meaning to improve this one. Would it be possible to include a note:

Suggested change
:func:`torch.export.export` for more details. This is only used when dynamo is True.
Only one parameter `dynamic_axes` or `dynamic_shapes` should be set
at the same time.
:func:`torch.export.export` for more details. This is only used (and preferred) when dynamo is True.
Only one parameter `dynamic_axes` or `dynamic_shapes` should be set
at the same time.

Copy link
Collaborator

@justinchuby justinchuby Sep 6, 2024

Choose a reason for hiding this comment

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

For dynamic_axes:

[...] When dynamo=True, a best effort conversion is done to convert to the dynamic_shapes argument for  :func:`torch.export.export`.

@justinchuby justinchuby added module: onnx Related to torch.onnx topic: docs topic category labels Sep 6, 2024
@justinchuby justinchuby changed the title [ONNX] Improves documentation of ONNX exporter. [ONNX] Improves documentation of ONNX exporter Sep 6, 2024
xadupre and others added 4 commits September 9, 2024 10:10
@xadupre @justinchuby
Update torch/onnx/__init__.py
b6ac899 
Co-authored-by: Justin Chu <justinchuby@users.noreply.github.com>
@xadupre @justinchuby
Update docs/source/onnx.rst
ec0063b 
Co-authored-by: Justin Chu <justinchuby@users.noreply.github.com>
@xadupre @justinchuby
Update docs/source/onnx_dynamo.rst
a6d211c 
Co-authored-by: Justin Chu <justinchuby@users.noreply.github.com>
@xadupre @justinchuby
Update torch/onnx/__init__.py
4fecb3f 
Co-authored-by: Justin Chu <justinchuby@users.noreply.github.com>
@justinchuby
Copy link
Collaborator

justinchuby commented Sep 9, 2024

@pytorchbot merge

@pytorch-bot pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Sep 9, 2024
@pytorchmergebot
Copy link
Collaborator

pytorchmergebot commented Sep 9, 2024

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

@justinchuby
Copy link
Collaborator

justinchuby commented Sep 9, 2024

@pytorchbot merge -f "docs"

@pytorch-bot
Copy link

pytorch-bot bot commented Sep 9, 2024

You need to provide a reason for using force merge, in the format @pytorchbot merge -f 'Explanation'.
The explanation needs to be clear on why this is needed. Here are some good examples:

  • Bypass checks due to unrelated upstream failures from ...
  • This is a minor fix to ..., which shouldn't break anything
  • This is pre-tested in a previous CI run
  • Bypass flaky ... check

@justinchuby
Copy link
Collaborator

justinchuby commented Sep 9, 2024

@pytorchbot merge -f "documentation updates only"

@pytorchmergebot
Copy link
Collaborator

pytorchmergebot commented Sep 9, 2024

The merge job was canceled or timed out. This most often happen if two merge requests were issued for the same PR, or if merge job was waiting for more than 6 hours for tests to finish. In later case, please do not hesitate to reissue the merge command
For more information see pytorch-bot wiki.

@pytorchmergebot
Copy link
Collaborator

pytorchmergebot commented Sep 9, 2024

Merge started

Your change will be merged immediately since you used the force (-f) flag, bypassing any CI checks (ETA: 1-5 minutes). Please use -f as last resort and instead consider -i/--ignore-current to continue the merge ignoring current failures. This will allow currently pending tests to finish and report signal before the merge.

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

justinchuby added a commit to justinchuby/pytorch that referenced this pull request Sep 9, 2024
@xadupre @justinchuby
[ONNX] Improves documentation of ONNX exporter (pytorch#135372)
9755ea4 
The PR updates the documentation to reflect the changes introduced in pytorch 2.5 and related to onnx exporter.

Pull Request resolved: pytorch#135372
Approved by: https://github.com/justinchuby

Co-authored-by: Justin Chu <justinchuby@users.noreply.github.com>
(cherry picked from commit 5e14586)
@justinchuby justinchuby mentioned this pull request Sep 9, 2024
Closed
malfet pushed a commit that referenced this pull request Sep 12, 2024
@justinchuby @xadupre
[ONNX] Improves documentation of ONNX exporter (#135526)
612fc7c 
The PR updates the documentation to reflect the changes introduced in pytorch 2.5 and related to onnx exporter.

Pull Request resolved: #135372
Approved by: https://github.com/justinchuby

Co-authored-by: Justin Chu <justinchuby@users.noreply.github.com>
(cherry picked from commit 5e14586)

Co-authored-by: Xavier Dupré <xadupre@users.noreply.github.com>
Chao1Han pushed a commit to Chao1Han/pytorch that referenced this pull request Sep 20, 2024
@xadupre @justinchuby @Chao1Han
[ONNX] Improves documentation of ONNX exporter (pytorch#135372)
7bee08c 
The PR updates the documentation to reflect the changes introduced in pytorch 2.5 and related to onnx exporter.

Pull Request resolved: pytorch#135372
Approved by: https://github.com/justinchuby

Co-authored-by: Justin Chu <justinchuby@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@justinchuby justinchuby justinchuby approved these changes

@titaiwangms titaiwangms Awaiting requested review from titaiwangms titaiwangms is a code owner

@shubhambhokare1 shubhambhokare1 Awaiting requested review from shubhambhokare1

@wschin wschin Awaiting requested review from wschin

Assignees

No one assigned

Labels

ciflow/trunk Trigger trunk jobs on your pull request Merged module: onnx Related to torch.onnx open source release notes: onnx torch.onnx related changes that should show up in the release notes topic: docs topic category

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@xadupre @justinchuby @pytorchmergebot @pytorchbot