Generate the ONNX and ONNX-ML operator doc in one run #3467
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
askhade
reviewed
May 4, 2021
askhade
reviewed
May 4, 2021
askhade
reviewed
May 4, 2021
askhade
suggested changes
May 4, 2021
added 2 commits
May 5, 2021 12:46
We need to setup env var `ONNX_ML` and run `gen_doc.py` twice to update the operator docs if both _ONNX_ and _ONNX-ML_ doc need to be updated. With this change, `python onnx/defs/gen_doc.py` generates _ONNX_ and _ONNX-ML_ doc in one run. Signed-off-by: Zhenhua Wang (王振华) <zhenhua.wzh@icloud.com>
Signed-off-by: Zhenhua Wang (王振华) <zhenhua.wzh@icloud.com>
d3fe877 to
706bed7
Compare
|
Hi @askhade thank you for the quick review. I have fixed your concerns, please help to check. |
askhade
approved these changes
May 5, 2021
Signed-off-by: Zhenhua Wang (王振华) <zhenhua.wzh@icloud.com>
|
Hmmm... Cannot reproduce the error with python 3.8. When trying to repro with the steps of the pipeline |
Merged
jcwchen
reviewed
May 15, 2021
|
Close since run twice for ONNX and ONNX-ML should be by design. Thanks for the review! |
|
@jackwish : I think you missunderstood the comment. Your PR is a good enhancement for the current scenario it just needs a little change. When ONNX_ML is set to 0 when building onnx we do not build ml ops and therefore if you run the gen doc script it will create an empty operators-ml.md file. This is what needs to be fixed. In CIs we do set ONNX_ML to 0 and after running gen_doc.py it produces as empty operators-ml.md and therefore CIs are failing. I hope you will reopen it and make this fix. |
This was referenced Jun 26, 2023
xadupre
added a commit
that referenced
this pull request
Jul 4, 2023
### Description <!-- - Describe your changes. --> Generate both onnx and onnx-ml operator docs when ONNX_ML=1 ### Motivation and Context <!-- - Why is this change required? What problem does it solve? --> <!-- - If it fixes an open issue, please link to the issue here. --> Closes #5377. Similar to #3467. Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com> Co-authored-by: Xavier Dupré <xadupre@users.noreply.github.com>
hamptonm1
pushed a commit
to hamptonm1/onnx
that referenced
this pull request
Jul 10, 2023
### Description <!-- - Describe your changes. --> Generate both onnx and onnx-ml operator docs when ONNX_ML=1 ### Motivation and Context <!-- - Why is this change required? What problem does it solve? --> <!-- - If it fixes an open issue, please link to the issue here. --> Closes onnx#5377. Similar to onnx#3467. Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com> Co-authored-by: Xavier Dupré <xadupre@users.noreply.github.com> Signed-off-by: Megan Hampton <hamptonm@us.ibm.com>
adityagoel4512
pushed a commit
to adityagoel4512/onnx
that referenced
this pull request
Jul 28, 2023
### Description <!-- - Describe your changes. --> Generate both onnx and onnx-ml operator docs when ONNX_ML=1 ### Motivation and Context <!-- - Why is this change required? What problem does it solve? --> <!-- - If it fixes an open issue, please link to the issue here. --> Closes onnx#5377. Similar to onnx#3467. Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com> Co-authored-by: Xavier Dupré <xadupre@users.noreply.github.com> Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512
pushed a commit
to adityagoel4512/onnx
that referenced
this pull request
Jul 28, 2023
### Description <!-- - Describe your changes. --> Generate both onnx and onnx-ml operator docs when ONNX_ML=1 ### Motivation and Context <!-- - Why is this change required? What problem does it solve? --> <!-- - If it fixes an open issue, please link to the issue here. --> Closes onnx#5377. Similar to onnx#3467. Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com> Co-authored-by: Xavier Dupré <xadupre@users.noreply.github.com> Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512
pushed a commit
to adityagoel4512/onnx
that referenced
this pull request
Jul 28, 2023
### Description <!-- - Describe your changes. --> Generate both onnx and onnx-ml operator docs when ONNX_ML=1 ### Motivation and Context <!-- - Why is this change required? What problem does it solve? --> <!-- - If it fixes an open issue, please link to the issue here. --> Closes onnx#5377. Similar to onnx#3467. Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com> Co-authored-by: Xavier Dupré <xadupre@users.noreply.github.com> Signed-off-by: Aditya Goel <agoel4512@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We need to setup env var
ONNX_MLand rungen_doc.pytwice to update the operator docs if both ONNX and ONNX-ML doc need to be updated.With this change,
python onnx/defs/gen_doc.pygenerates ONNX and ONNX-ML doc in one run.