Add onnx export #2596

lezwon · 2020-07-13T10:47:05Z

What does this PR do?

Adds functionality to quickly export your model to ONNX format.

Before submitting

Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
Did you read the contributor guideline, Pull Request section?
Did you make sure your PR does only one thing, instead of bundling different changes together? Otherwise, we ask you to create a separate PR for every change.
Did you make sure to update the documentation with your changes?
Did you write any new necessary tests?
Did you verify new and existing tests pass locally with your changes?
If you made a notable change (that affects users), did you update the CHANGELOG?

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

tests/base/model_template.py

Borda

can we also add a test on inference?

lezwon · 2020-07-13T11:26:36Z

can we also add a test on inference?

Do you mean using the ONNX Runtime?

Borda · 2020-07-13T12:52:42Z

can we also add a test on inference?

Do you mean using the ONNX Runtime?

yes, or another way how to test that it really does something - accept given array as input and returns an output in expected range

lezwon · 2020-07-13T18:17:10Z

can we also add a test on inference?

Do you mean using the ONNX Runtime?

yes, or another way how to test that it really does something - accept given array as input and returns an output in expected range

Cool. I'll add tests based on the examples mentioned here: https://pytorch.org/tutorials/advanced/super_resolution_with_onnxruntime.html

justusschock · 2020-07-13T19:51:15Z

we should add a test, that the outputs of the exported model match the outputs of the original one :)

pep8speaks · 2020-07-14T03:46:17Z

Hello @lezwon! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-07-31 08:02:08 UTC

lezwon · 2020-07-14T04:29:45Z

we should add a test, that the outputs of the exported model match the outputs of the original one :)

I've added that one in test_if_inference_output_is_valid :]

lezwon · 2020-07-14T06:35:57Z

@Borda I need some help with the tests. It's breaking on ubuntu-20.04 because onnx is not installed on it. Seems to be working on others.

Borda · 2020-07-14T07:07:50Z

Borda I need some help with the tests. It's breaking on ubuntu-20.04 because onnx is not installed on it. Seems to be working on others.

The problem is not Ubuntu, but using Conda, you have added the dependency to pip env, so you need to add it also here:
https://github.com/PyTorchLightning/pytorch-lightning/blob/master/environment.yml

jeremyjordan

This looks great! Easy export to ONNX is a nice feature and I really appreciate all the tests you've written to ensure the feature remains stable :)

pytorch_lightning/core/lightning.py

justusschock

LGTM, just one minor note :)

pytorch_lightning/core/lightning.py

CHANGELOG.md

pytorch_lightning/core/lightning.py

requirements/extra.txt

Borda · 2020-07-20T11:21:54Z

tests/base/model_template.py

-        # if you specify an example input, the summary will show input/output for each layer
-        # TODO: to be fixed in #1773
-        # self.example_input_array = torch.rand(5, 28 * 28)
+        self.example_input_array = torch.rand(5, 28 * 28)


I thought we were talking about having it as property, right? @awaelchli

you mean the user overrides the property function?

yes, at least we talked about it but maybe there was some picking issue?

tests/models/test_onnx_save.py

lezwon · 2020-07-29T09:33:58Z

@lezwon are there docs?
can you add a new section called production or something like that in common use cases.

Sure. Will do that :]

add to changelog

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

CHANGELOG.md

mergify bot requested a review from a team July 13, 2020 10:47

lezwon force-pushed the feature/2271_onnx_export branch from 6c6e233 to 19f9a44 Compare July 13, 2020 10:52

Borda added feature Is an improvement or enhancement Important labels Jul 13, 2020

Borda added this to the 0.9.0 milestone Jul 13, 2020

Borda reviewed Jul 13, 2020

View reviewed changes

tests/base/model_template.py Outdated Show resolved Hide resolved

mergify bot requested a review from a team July 13, 2020 11:16

Borda approved these changes Jul 13, 2020

View reviewed changes

mergify bot requested a review from a team July 13, 2020 11:18

jeremyjordan approved these changes Jul 15, 2020

View reviewed changes

mergify bot requested a review from a team July 15, 2020 02:27

williamFalcon reviewed Jul 15, 2020

View reviewed changes

pytorch_lightning/core/lightning.py Show resolved Hide resolved

mergify bot requested a review from a team July 15, 2020 03:25

Borda requested a review from awaelchli July 15, 2020 06:12

justusschock approved these changes Jul 15, 2020

View reviewed changes

pytorch_lightning/core/lightning.py Show resolved Hide resolved

lezwon force-pushed the feature/2271_onnx_export branch from 6249630 to 747f079 Compare July 16, 2020 04:52

lezwon marked this pull request as ready for review July 19, 2020 18:41

rohitgr7 reviewed Jul 19, 2020

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Borda reviewed Jul 20, 2020

View reviewed changes

pytorch_lightning/core/lightning.py Outdated Show resolved Hide resolved

Borda reviewed Jul 20, 2020

View reviewed changes

requirements/extra.txt Show resolved Hide resolved

Borda reviewed Jul 20, 2020

View reviewed changes

tests/models/test_onnx_save.py Outdated Show resolved Hide resolved

lezwon force-pushed the feature/2271_onnx_export branch from eb9b6e4 to 9765c31 Compare July 29, 2020 19:01

lezwon and others added 22 commits July 30, 2020 00:32

export model to onnx

88a9eda

prepare data before exporting

29c330e

support for dataloaders and tensors

c154e4a

added tests

08f75e7

use example_input_array

61cf39f

add to changelog

updated docstring

feb7b56

added onnx inference tests

81cc4a0

temp commit

cb92d28

removed schema valid test

4f2aadc

add onnxruntime to environment.yml

0289f2b

moved onnxruntime to environment.yml pip

9a8b129

add example in doc

5265578

add lines between code block

de3b028

added PR to changelog

467eba1

is file check

d5e3eb6

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

remove *

a6065fb

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

infer example outputs

0fb4b28

added doctest for onnx

49982a3

fix windows tests

434c8d8

moved eval within condition block

b7ead43

self.forward to self

633a47c

added docs

add43b7

lezwon force-pushed the feature/2271_onnx_export branch from 9765c31 to add43b7 Compare July 29, 2020 19:03

lezwon added 2 commits July 30, 2020 00:42

fixed docs error

d71f744

added to toctree

cd5df3f

Borda reviewed Jul 31, 2020

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

dcc0ad9

Borda merged commit b7afac3 into Lightning-AI:master Jul 31, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add onnx export #2596

Add onnx export #2596

lezwon commented Jul 13, 2020 •

edited

Loading

Borda left a comment

lezwon commented Jul 13, 2020

Borda commented Jul 13, 2020

lezwon commented Jul 13, 2020

justusschock commented Jul 13, 2020

pep8speaks commented Jul 14, 2020 •

edited

Loading

lezwon commented Jul 14, 2020

lezwon commented Jul 14, 2020

Borda commented Jul 14, 2020

jeremyjordan left a comment

justusschock left a comment

Borda Jul 20, 2020

awaelchli Jul 20, 2020

Borda Jul 20, 2020

lezwon commented Jul 29, 2020

Add onnx export #2596

Add onnx export #2596

Conversation

lezwon commented Jul 13, 2020 • edited Loading

What does this PR do?

Before submitting

PR review

Did you have fun?

Borda left a comment

Choose a reason for hiding this comment

lezwon commented Jul 13, 2020

Borda commented Jul 13, 2020

lezwon commented Jul 13, 2020

justusschock commented Jul 13, 2020

pep8speaks commented Jul 14, 2020 • edited Loading

Comment last updated at 2020-07-31 08:02:08 UTC

lezwon commented Jul 14, 2020

lezwon commented Jul 14, 2020

Borda commented Jul 14, 2020

jeremyjordan left a comment

Choose a reason for hiding this comment

justusschock left a comment

Choose a reason for hiding this comment

Borda Jul 20, 2020

Choose a reason for hiding this comment

awaelchli Jul 20, 2020

Choose a reason for hiding this comment

Borda Jul 20, 2020

Choose a reason for hiding this comment

lezwon commented Jul 29, 2020

lezwon commented Jul 13, 2020 •

edited

Loading

pep8speaks commented Jul 14, 2020 •

edited

Loading