Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[v1.x] Update ONNX tutorial and doc #20253

Merged
merged 3 commits into from
May 12, 2021
Merged

[v1.x] Update ONNX tutorial and doc #20253

merged 3 commits into from
May 12, 2021

Conversation

waytrue17
Copy link
Contributor

Description

Update ONNX tutorial and doc

Checklist

Essentials

  • PR's title starts with a category (e.g. [BUGFIX], [MODEL], [TUTORIAL], [FEATURE], [DOC], etc)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage
  • Code is well-documented

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

@mxnet-bot
Copy link

Hey @waytrue17 , Thanks for submitting the PR
All tests are already queued to run once. If tests fail, you can trigger one or more tests again with the following commands:

  • To trigger all jobs: @mxnet-bot run ci [all]
  • To trigger specific jobs: @mxnet-bot run ci [job1, job2]

CI supported jobs: [unix-cpu, clang, unix-gpu, edge, windows-gpu, windows-cpu, website, sanity, centos-cpu, centos-gpu, miscellaneous]

Note:
Only following 3 categories can trigger CI :PR Author, MXNet Committer, Jenkins Admin.
All CI tests must pass before the PR can be merged.

@mseth10 mseth10 added the pr-awaiting-testing PR is reviewed and waiting CI build and test label May 7, 2021
Zha0q1
Zha0q1 reviewed May 7, 2021
View reviewed changes
python/mxnet/onnx/README.md Outdated
By setting up optional flags in export_model API, users have the control of partially/fully dynamic shape input export. The flag `dynamic` is set to switch on dynamic shape input export, and `dynamic_input_shapes` is used to specify which dimensions are dynamic (None for dynamic shape).

```python
# None indicating dynamic shape at a certain dimension
Copy link
Contributor

Choose a reason for hiding this comment

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

here the dynamic shape can also be something like ('batch', 'seq_length') i.e. using strings rather than None

Copy link
Contributor Author

@waytrue17 waytrue17 May 7, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Updated the description

@Zha0q1
Copy link
Contributor

Zha0q1 commented May 7, 2021 •
edited
Loading

I think we might also touch on dynamic shapes in the tutorial as this is a very common use case e.g. different image sizes or sequence lengths. Also I think we can add a section to introduce onnx-simplifier as it can significantly simplify the onnx graph in many cases.

CC the author of onnxsim @daquexian: we are releasing mx2onnx in the upcoming mxnet 1.9 release : )

@mseth10 mseth10 added pr-awaiting-review PR is waiting for code review and removed pr-awaiting-testing PR is reviewed and waiting CI build and test labels May 7, 2021
@mseth10 mseth10 added pr-awaiting-testing PR is reviewed and waiting CI build and test and removed pr-awaiting-review PR is waiting for code review labels May 7, 2021
@waytrue17
Copy link
Contributor Author

I think we might also touch on dynamic shapes in the tutorial as this is a very common use case e.g. different image sizes or sequence lengths. Also I think we can add a section to introduce onnx-simplifier as it can significantly simplify the onnx graph in many cases.

CC the author of onnxsim @daquexian: we are releasing mx2onnx in the upcoming mxnet 1.9 release : )

Added dynamic shape input in the tutorial, and a link reference to onnx-simp

@mseth10 mseth10 added pr-work-in-progress PR is still work in progress and removed pr-awaiting-testing PR is reviewed and waiting CI build and test labels May 8, 2021
Zha0q1
Zha0q1 approved these changes May 10, 2021
View reviewed changes
Copy link
Contributor

@Zha0q1 Zha0q1 left a comment

Choose a reason for hiding this comment

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

LGTM!

@mseth10 mseth10 added pr-awaiting-testing PR is reviewed and waiting CI build and test pr-work-in-progress PR is still work in progress pr-awaiting-merge Review and CI is complete. Ready to Merge and removed pr-work-in-progress PR is still work in progress pr-awaiting-testing PR is reviewed and waiting CI build and test labels May 10, 2021
@Zha0q1 Zha0q1 merged commit a579328 into apache:v1.x May 12, 2021
@waytrue17 waytrue17 deleted the onnx-doc branch May 28, 2021 00:36
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Zha0q1 Zha0q1 Zha0q1 approved these changes

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

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

Assignees
No one assigned
Labels
pr-awaiting-merge Review and CI is complete. Ready to Merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@waytrue17 @mxnet-bot @Zha0q1 @mseth10