Fix gen_doc build option and refresh documentation
#3545
Merged
Conversation
This file contains 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
hariharans29
commented
Apr 16, 2020
| @@ -391,17 +391,6 @@ void addGlobalMethods(py::module& m, const Environment& env) { | |||
| "get_all_opkernel_def", []() -> const std::vector<onnxruntime::KernelDef> { | |||
| std::vector<onnxruntime::KernelDef> result; | |||
|
|
|||
| // default logger is needed to create the DNNLExecutionProvider | |||
| std::string default_logger_id{"DefaultLogger"}; | |||
There was a problem hiding this comment.
default logger is already created by the time execution flow reaches this line
hariharans29
commented
Apr 16, 2020
| @@ -868,15 +868,15 @@ def generate_documentation(source_dir, build_dir, configs): | |||
| operator_doc_path = os.path.join(source_dir, 'docs', 'ContribOperators.md') | |||
| opkernel_doc_path = os.path.join(source_dir, 'docs', 'OperatorKernels.md') | |||
| for config in configs: | |||
| #copy the gen_doc.py | |||
| shutil.copy(os.path.join(source_dir,'tools','python','gen_doc.py'), | |||
| #copy the gen_contrib_doc.py | |||
There was a problem hiding this comment.
renamed file to a name more indicative of its function
hariharans29
commented
Apr 16, 2020
| @@ -930,7 +930,7 @@ def main(): | |||
| if args.use_tensorrt: | |||
| args.use_cuda = True | |||
|
|
|||
| if args.build_wheel: | |||
| if args.build_wheel or args.gen_doc: | |||
| args.enable_pybind = True | |||
There was a problem hiding this comment.
pybind is to be enabled even if user doesn't state it as op schema/kernel def are available to script via Python bindings
hariharans29
commented
Apr 16, 2020
| @@ -15,7 +15,6 @@ | |||
|
|
|||
| import numpy as np # type: ignore | |||
|
|
|||
| import onnxruntime as rt | |||
There was a problem hiding this comment.
Don't need ORT in either of the scripts
hariharans29
commented
Apr 16, 2020
| @@ -41,7 +40,7 @@ def format_param_strings(params): | |||
| firstparam = True | |||
| s = '' | |||
| if params: | |||
| for param in params: | |||
| for param in sorted(params): | |||
There was a problem hiding this comment.
sort wherever possible to avoid order ambiguity and thus avoid False Positive diffs in the md files
hariharans29
commented
Apr 16, 2020
jywu-msft
approved these changes
Apr 17, 2020
This was referenced Jul 15, 2021
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.
Description:
gen_docbuild option was broken. This change fixes it. Enforcing doc updates with build breaks if doc updates are not checked-in as part of each relevant PR is still WIP but this PR has some changes to eventually enable that.Motivation and Context
MQ work-item