Skip to content

Update OpSchema docs to include new methods and classes #5297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 13, 2023

Conversation

justinchuby
Copy link
Member

Description

Update OpSchema docs

Fixes #5292

@justinchuby justinchuby requested a review from a team as a code owner June 10, 2023 16:32
@justinchuby justinchuby changed the title Update OpSchema docs Update OpSchema docs to include new methods and classes Jun 10, 2023
@justinchuby justinchuby force-pushed the justinchu/opschema-docs branch from 2edd8b6 to cc60938 Compare June 10, 2023 16:55
@justinchuby justinchuby requested a review from a team as a code owner June 10, 2023 16:55
@justinchuby justinchuby force-pushed the justinchu/opschema-docs branch from cc60938 to 72e6edc Compare June 10, 2023 16:56
Signed-off-by: Justin Chu <justinchu@microsoft.com>
@justinchuby justinchuby force-pushed the justinchu/opschema-docs branch from 72e6edc to 8dec575 Compare June 11, 2023 14:47
@justinchuby justinchuby requested review from jcwchen and removed request for a team June 11, 2023 15:09
Copy link
Member

@jcwchen jcwchen left a comment

Choose a reason for hiding this comment

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

https://github.com/onnx/onnx/blob/main/docs/PythonAPIOverview.md is another entry point for new ONNX users. It would be useful if ONNX can have some examples for these new methods I think.

@justinchuby
Copy link
Member Author

Should we migrate this markdown to the onnx docs website? The info seems to be redundant?

@jcwchen jcwchen merged commit 0f53636 into onnx:main Jun 13, 2023
@jcwchen
Copy link
Member

jcwchen commented Jun 13, 2023

Should we migrate this markdown to the onnx docs website? The info seems to be redundant?

PythonAPIOverview.md is more like an overview only with important APIs. Some of APIs are not included I think. Currently I don't see similar section on the web? Still, thank you for the PR of moving PythonAPIOverview.md to the web: #5312.

@justinchuby justinchuby deleted the justinchu/opschema-docs branch June 13, 2023 05:57
@justinchuby
Copy link
Member Author

I can migrate the doc to the index page for APIs in the online doc

adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
Signed-off-by: Justin Chu <justinchu@microsoft.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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation for OpSchema
3 participants