From a0f3e30de67ea63a481e5ea11505e576967ab073 Mon Sep 17 00:00:00 2001 From: Cassie <46505951+cassiebreviu@users.noreply.github.com> Date: Wed, 15 Sep 2021 16:23:42 -0500 Subject: [PATCH] Docs update: updated nav, get started sections, home page, apis (#9060) * initial setup and rename "how to" to "setup" * move API to main nav * move api to main nav * add get starated, rework nav order * rename to install move mds out of install section * update api nav and home page * add install docs and python qs updates * python get started work * remove c and obj c for now * move java, python, and obj-c docs under api folder * move java api html to iframe (ugh) * remove api docs w/o details, move api text getstar * remove api docs wo detail updates get started * remvoe iframes * move eco system to main nav * fix api buttons * added more examples moved intro to ORT * fix links * fix get started titles * fix get started titles * fix more links * fix more links * more link fixes * fix nav remove inferencing and training subnav * fix top nav remove inference and training nav * fix title * fix tutorials nav hierarchy * fix python api button * add tenorflow keras example * fix quickstart toc * add imports fix spacing * fix links * update nav and python get started page * move ort training example, add coming soon for iot * update C# get started * fix spacing on quantization * Add some js get started content * fix formatting * fix typo * removed onnx-pytorch and onnx-tf * updated pip install torch and added links iot page * added pytorch tutorial heirarchy * updated web to docs soon added release blog link * add web link --- .gitignore | 1 + _config.yml | 17 +- about.html | 6 +- .../csharp-api.md} | 7 +- docs/api/index.md | 15 ++ docs/api/java-api.md | 10 + .../api/java}/ai/onnxruntime/MapInfo.html | 0 .../api/java}/ai/onnxruntime/NodeInfo.html | 0 .../java}/ai/onnxruntime/OnnxJavaType.html | 0 .../onnxruntime/OnnxMap.OnnxMapValueType.html | 0 .../api/java}/ai/onnxruntime/OnnxMap.html | 0 .../java}/ai/onnxruntime/OnnxSequence.html | 0 .../api/java}/ai/onnxruntime/OnnxTensor.html | 0 .../onnxruntime/OnnxValue.OnnxValueType.html | 0 .../api/java}/ai/onnxruntime/OnnxValue.html | 0 .../OrtEnvironment.LoggingLevel.html | 0 .../java}/ai/onnxruntime/OrtEnvironment.html | 0 .../OrtException.OrtErrorCode.html | 0 .../java}/ai/onnxruntime/OrtException.html | 0 .../ai/onnxruntime/OrtSession.Result.html | 0 ...tSession.SessionOptions.ExecutionMode.html | 0 .../OrtSession.SessionOptions.OptLevel.html | 0 .../OrtSession.SessionOptions.html | 0 .../api/java}/ai/onnxruntime/OrtSession.html | 0 .../api/java}/ai/onnxruntime/OrtUtil.html | 0 .../java}/ai/onnxruntime/SequenceInfo.html | 0 .../TensorInfo.OnnxTensorType.html | 0 .../api/java}/ai/onnxruntime/TensorInfo.html | 0 .../api/java}/ai/onnxruntime/ValueInfo.html | 0 .../ai/onnxruntime/class-use/MapInfo.html | 0 .../ai/onnxruntime/class-use/NodeInfo.html | 0 .../onnxruntime/class-use/OnnxJavaType.html | 0 .../class-use/OnnxMap.OnnxMapValueType.html | 0 .../ai/onnxruntime/class-use/OnnxMap.html | 0 .../onnxruntime/class-use/OnnxSequence.html | 0 .../ai/onnxruntime/class-use/OnnxTensor.html | 0 .../class-use/OnnxValue.OnnxValueType.html | 0 .../ai/onnxruntime/class-use/OnnxValue.html | 0 .../OrtEnvironment.LoggingLevel.html | 0 .../onnxruntime/class-use/OrtEnvironment.html | 0 .../class-use/OrtException.OrtErrorCode.html | 0 .../onnxruntime/class-use/OrtException.html | 0 .../class-use/OrtSession.Result.html | 0 ...tSession.SessionOptions.ExecutionMode.html | 0 .../OrtSession.SessionOptions.OptLevel.html | 0 .../class-use/OrtSession.SessionOptions.html | 0 .../ai/onnxruntime/class-use/OrtSession.html | 0 .../ai/onnxruntime/class-use/OrtUtil.html | 0 .../onnxruntime/class-use/SequenceInfo.html | 0 .../class-use/TensorInfo.OnnxTensorType.html | 0 .../ai/onnxruntime/class-use/TensorInfo.html | 0 .../ai/onnxruntime/class-use/ValueInfo.html | 0 .../java}/ai/onnxruntime/package-frame.html | 0 .../java}/ai/onnxruntime/package-summary.html | 0 .../java}/ai/onnxruntime/package-tree.html | 0 .../api/java}/ai/onnxruntime/package-use.html | 0 {java => docs/api/java}/allclasses-frame.html | 0 .../api/java}/allclasses-noframe.html | 0 {java => docs/api/java}/constant-values.html | 0 {java => docs/api/java}/deprecated-list.html | 0 {java => docs/api/java}/help-doc.html | 0 {java => docs/api/java}/index-all.html | 0 {java => docs/api/java}/index.html | 0 {java => docs/api/java}/overview-tree.html | 0 {java => docs/api/java}/package-list | 0 {java => docs/api/java}/script.js | 0 {java => docs/api/java}/serialized-form.html | 0 {java => docs/api/java}/stylesheet.css | 2 +- docs/api/objectivec-api.md | 10 + .../api/objectivec}/Classes.html | 0 .../ORTCoreMLExecutionProviderOptions.html | 0 .../api/objectivec}/Classes/ORTEnv.html | 0 .../objectivec}/Classes/ORTRunOptions.html | 0 .../api/objectivec}/Classes/ORTSession.html | 0 .../Classes/ORTSessionOptions.html | 0 .../Classes/ORTTensorTypeAndShapeInfo.html | 0 .../api/objectivec}/Classes/ORTValue.html | 0 .../objectivec}/Classes/ORTValueTypeInfo.html | 0 .../api/objectivec}/Enums.html | 0 .../Enums/ORTGraphOptimizationLevel.html | 0 .../objectivec}/Enums/ORTLoggingLevel.html | 0 .../Enums/ORTTensorElementDataType.html | 0 .../api/objectivec}/Enums/ORTValueType.html | 0 .../api/objectivec}/Functions.html | 0 .../api/objectivec}/css/highlight.css | 0 .../api/objectivec}/css/jazzy.css | 0 .../Contents/Info.plist | 0 .../Contents/Resources/Documents/Classes.html | 0 .../ORTCoreMLExecutionProviderOptions.html | 0 .../Resources/Documents/Classes/ORTEnv.html | 0 .../Documents/Classes/ORTRunOptions.html | 0 .../Documents/Classes/ORTSession.html | 0 .../Documents/Classes/ORTSessionOptions.html | 0 .../Classes/ORTTensorTypeAndShapeInfo.html | 0 .../Resources/Documents/Classes/ORTValue.html | 0 .../Documents/Classes/ORTValueTypeInfo.html | 0 .../Contents/Resources/Documents/Enums.html | 0 .../Enums/ORTGraphOptimizationLevel.html | 0 .../Documents/Enums/ORTLoggingLevel.html | 0 .../Enums/ORTTensorElementDataType.html | 0 .../Documents/Enums/ORTValueType.html | 0 .../Resources/Documents/Functions.html | 0 .../Resources/Documents/css/highlight.css | 0 .../Resources/Documents/css/jazzy.css | 0 .../Resources/Documents/img/carat.png | Bin .../Contents/Resources/Documents/img/dash.png | Bin .../Contents/Resources/Documents/img/gh.png | Bin .../Resources/Documents/img/spinner.gif | Bin .../Contents/Resources/Documents/index.html | 0 .../Contents/Resources/Documents/js/jazzy.js | 0 .../Resources/Documents/js/jazzy.search.js | 0 .../Resources/Documents/js/jquery.min.js | 0 .../Resources/Documents/js/lunr.min.js | 0 .../Documents/js/typeahead.jquery.js | 0 .../Contents/Resources/Documents/search.json | 0 .../Contents/Resources/docSet.dsidx | Bin .../docsets/ONNX Runtime Objective-C API.tgz | Bin .../api/objectivec}/img/carat.png | Bin .../api/objectivec}/img/dash.png | Bin .../api/objectivec}/img/gh.png | Bin .../api/objectivec}/img/spinner.gif | Bin .../api/objectivec}/index.html | 0 .../api/objectivec}/js/jazzy.js | 0 .../api/objectivec}/js/jazzy.search.js | 0 .../api/objectivec}/js/jquery.min.js | 0 .../api/objectivec}/js/lunr.min.js | 0 .../api/objectivec}/js/typeahead.jquery.js | 0 .../api/objectivec}/search.json | 0 docs/{reference => }/api/other-apis.md | 9 +- docs/api/python-api.md | 11 + {python => docs/api/python}/.buildinfo | 0 {python => docs/api/python}/.nojekyll | 0 {python => docs/api/python}/README.html | 0 {python => docs/api/python}/api_summary.html | 51 ---- .../api/python}/auto_examples/index.html | 4 +- .../python}/auto_examples/plot_backend.html | 0 .../auto_examples/plot_common_errors.html | 0 .../plot_convert_pipeline_vectorizer.html | 0 .../python}/auto_examples/plot_dl_keras.html | 0 .../auto_examples/plot_load_and_predict.html | 0 .../python}/auto_examples/plot_metadata.html | 0 .../python}/auto_examples/plot_pipeline.html | 0 .../python}/auto_examples/plot_profiling.html | 0 .../plot_train_convert_predict.html | 0 .../auto_examples/sg_execution_times.html | 0 .../auto_examples_python.zip | Bin .../plot_train_convert_predict.ipynb | 0 .../plot_common_errors.ipynb | 0 .../plot_load_and_predict.ipynb | 0 .../plot_pipeline.ipynb | 0 .../plot_train_convert_predict.ipynb | 0 .../plot_common_errors.py | 0 .../plot_convert_pipeline_vectorizer.ipynb | 0 .../plot_backend.py | 0 .../plot_load_and_predict.py | 0 .../plot_convert_pipeline_vectorizer.py | 0 .../plot_backend.ipynb | 0 .../auto_examples_jupyter.zip | Bin .../plot_load_and_predict.py | 0 .../plot_metadata.py | 0 .../plot_common_errors.py | 0 .../plot_common_errors.ipynb | 0 .../plot_metadata.py | 0 .../plot_metadata.ipynb | 0 .../plot_pipeline.py | 0 .../plot_convert_pipeline_vectorizer.py | 0 .../plot_profiling.ipynb | 0 .../plot_metadata.ipynb | 0 .../plot_dl_keras.py | 0 .../plot_convert_pipeline_vectorizer.ipynb | 0 .../plot_pipeline.ipynb | 0 .../plot_train_convert_predict.py | 0 .../plot_dl_keras.ipynb | 0 .../plot_profiling.ipynb | 0 .../plot_profiling.py | 0 .../plot_pipeline.py | 0 .../plot_train_convert_predict.py | 0 .../plot_load_and_predict.ipynb | 0 .../plot_backend.py | 0 .../plot_profiling.py | 0 .../plot_backend.ipynb | 0 {python => docs/api/python}/examples_md.html | 0 {python => docs/api/python}/genindex.html | 0 .../images/sphx_glr_plot_backend_thumb.png | Bin .../sphx_glr_plot_common_errors_thumb.png | Bin ...plot_convert_pipeline_vectorizer_thumb.png | Bin .../sphx_glr_plot_load_and_predict_thumb.png | Bin .../images/sphx_glr_plot_metadata_thumb.png | Bin .../images/sphx_glr_plot_pipeline_001.png | Bin .../images/sphx_glr_plot_pipeline_thumb.png | Bin .../images/sphx_glr_plot_profiling_thumb.png | Bin ...phx_glr_plot_train_convert_predict_001.png | Bin ...x_glr_plot_train_convert_predict_thumb.png | Bin {python => docs/api/python}/index.html | 0 .../api/python}/modules/index.html | 0 .../onnxruntime_inference_collection.html | 0 .../python}/modules/onnxruntime/datasets.html | 0 {python => docs/api/python}/objects.inv | Bin {python => docs/api/python}/search.html | 0 {python => docs/api/python}/searchindex.js | 0 .../api/python}/sources/README.rst.txt | 0 .../api/python}/sources/api_summary.rst.txt | 0 .../sources/auto_examples/index.rst.txt | 0 .../auto_examples/plot_backend.rst.txt | 0 .../auto_examples/plot_common_errors.rst.txt | 0 .../plot_convert_pipeline_vectorizer.rst.txt | 0 .../auto_examples/plot_dl_keras.rst.txt | 0 .../plot_load_and_predict.rst.txt | 0 .../auto_examples/plot_metadata.rst.txt | 0 .../auto_examples/plot_pipeline.rst.txt | 0 .../auto_examples/plot_profiling.rst.txt | 0 .../plot_train_convert_predict.rst.txt | 0 .../auto_examples/sg_execution_times.rst.txt | 0 .../api/python}/sources/examples_md.rst.txt | 0 .../api/python}/sources/index.rst.txt | 0 .../api/python}/sources/tutorial.rst.txt | 0 .../api/python}/static/ONNX_Runtime_icon.png | Bin .../api/python}/static/alabaster.css | 0 {python => docs/api/python}/static/basic.css | 0 .../api/python}/static/binder_badge_logo.svg | 0 .../api/python}/static/broken_example.png | Bin {python => docs/api/python}/static/custom.css | 0 .../api/python}/static/doctools.js | 0 .../python}/static/documentation_options.js | 0 {python => docs/api/python}/static/file.png | Bin .../api/python}/static/gallery-binder.css | 0 .../api/python}/static/gallery-dataframe.css | 0 .../python}/static/gallery-rendered-html.css | 0 .../api/python}/static/gallery.css | 0 .../api/python}/static/graphviz.css | 0 .../api/python}/static/jquery-3.5.1.js | 0 {python => docs/api/python}/static/jquery.js | 0 .../api/python}/static/language_data.js | 0 {python => docs/api/python}/static/minus.png | Bin .../api/python}/static/no_image.png | Bin {python => docs/api/python}/static/plus.png | Bin .../api/python}/static/pygments.css | 0 .../api/python}/static/searchtools.js | 0 .../api/python}/static/underscore-1.12.0.js | 0 .../api/python}/static/underscore-1.3.1.js | 0 .../api/python}/static/underscore.js | 0 {python => docs/api/python}/tutorial.html | 0 docs/api/winrt-api.md | 10 + docs/{how-to => }/build/android-ios.md | 7 +- docs/{how-to => }/build/eps.md | 27 +- docs/{how-to => }/build/index.md | 3 +- docs/{how-to => }/build/inferencing.md | 1 - docs/{how-to => }/build/reduced.md | 1 - docs/{how-to => }/build/training.md | 1 - docs/build/web.md | 14 + .../ecosystem.md => ecosystem/index.md} | 33 ++- .../ACL-ExecutionProvider.md | 12 +- .../ArmNN-ExecutionProvider.md | 8 +- .../CUDA-ExecutionProvider.md | 5 +- .../CoreML-ExecutionProvider.md | 4 +- .../DirectML-ExecutionProvider.md | 8 +- .../MIGraphX-ExecutionProvider.md | 8 +- .../NNAPI-ExecutionProvider.md | 4 +- .../Nuphar-ExecutionProvider.md | 4 +- .../OpenVINO-ExecutionProvider.md | 6 +- .../RKNPU-ExecutionProvider.md | 6 +- .../TensorRT-ExecutionProvider.md | 8 +- .../Vitis-AI-ExecutionProvider.md | 4 +- .../add-execution-provider.md | 4 +- .../execution-providers/index.md | 7 +- .../oneDNN-ExecutionProvider.md | 8 +- docs/get-started/index.md | 10 + docs/get-started/training-pytorch.md | 38 +++ .../api/c-api.md => get-started/with-c.md} | 17 +- .../cpp-api.md => get-started/with-cpp.md} | 15 +- .../with-csharp.md} | 101 +++++-- docs/get-started/with-iot.md | 11 + .../java-api.md => get-started/with-java.md} | 11 +- docs/get-started/with-javascript.md | 104 +++++++ docs/get-started/with-mobile.md | 49 ++++ .../with-obj-c.md} | 16 +- docs/get-started/with-python.md | 255 ++++++++++++++++++ .../with-winrt.md} | 13 +- docs/how-to/build/web.md | 10 - docs/how-to/index.md | 8 - docs/index.md | 62 ++--- docs/{how-to/install.md => install/index.md} | 133 +++++++-- .../graph-optimizations.md | 4 +- docs/performance/index.md | 7 + .../mobile-performance-tuning.md | 12 +- docs/{how-to => performance}/quantization.md | 4 +- .../tune-performance.md | 12 +- docs/reference/api/index.md | 7 - docs/reference/api/js-api.md | 41 --- docs/reference/api/python-api.md | 38 --- docs/reference/api/training-pytorch.md | 19 -- .../{resources => reference}/compatibility.md | 6 +- .../high-level-design.md | 10 +- docs/reference/index.md | 2 +- .../operators}/add-custom-op.md | 5 +- .../operators}/custom-python-operator.md | 2 + docs/resources/index.md | 7 - .../squeezenet_classification_cpp.md | 0 .../tiny_yolo_v2_object_detection_python.md | 0 .../yolov3_object_detection_csharp.md | 0 docs/tutorials/accelerate-pytorch/index.md | 8 + .../ort-training.md | 6 +- .../pytorch.md | 14 +- .../tutorials/{inferencing => }/api-basics.md | 3 +- .../tutorials/{tutorials => }/basic_csharp.md | 0 .../{tutorials => }/export-pytorch-model.md | 0 .../{tutorials => }/fasterrcnn_csharp.md | 0 .../{inferencing => }/huggingface.md | 3 +- docs/tutorials/index.md | 2 +- docs/tutorials/inferencing/index.md | 14 - docs/tutorials/inferencing/web.md | 11 - docs/tutorials/{inferencing => }/iot-edge.md | 3 +- docs/tutorials/{tutorials => }/mnist_cpp.md | 0 docs/tutorials/{tutorials => }/mnist_java.md | 0 docs/tutorials/{inferencing => }/mobile.md | 5 +- .../mobile/custom-build.md | 2 +- docs/{how-to => tutorials}/mobile/index.md | 4 +- .../mobile/initial-setup.md | 2 +- .../mobile/limitations.md | 2 +- .../mobile/model-conversion.md | 4 +- .../mobile/model-execution.md | 4 +- docs/{how-to => tutorials}/mobile/overview.md | 4 +- .../using-nnapi-coreml-with-ort-mobile.md | 6 +- .../{tutorials => }/resnet50_csharp.md | 0 .../tutorials/{inferencing => }/tensorflow.md | 16 +- .../{tutorials => }/tf-get-started.md | 2 +- .../{inferencing => }/traditional-ml.md | 3 +- docs/tutorials/training/docs - Shortcut.lnk | Bin 1393 -> 0 bytes docs/tutorials/training/index.md | 9 - docs/tutorials/web.md | 14 + index.html | 2 +- 331 files changed, 989 insertions(+), 519 deletions(-) rename docs/{reference/api/csharp-api-reference.md => api/csharp-api.md} (97%) create mode 100644 docs/api/index.md create mode 100644 docs/api/java-api.md rename {java => docs/api/java}/ai/onnxruntime/MapInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/NodeInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OnnxJavaType.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OnnxMap.OnnxMapValueType.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OnnxMap.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OnnxSequence.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OnnxTensor.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OnnxValue.OnnxValueType.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OnnxValue.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtEnvironment.LoggingLevel.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtEnvironment.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtException.OrtErrorCode.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtException.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtSession.Result.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtSession.SessionOptions.OptLevel.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtSession.SessionOptions.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtSession.html (100%) rename {java => docs/api/java}/ai/onnxruntime/OrtUtil.html (100%) rename {java => docs/api/java}/ai/onnxruntime/SequenceInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/TensorInfo.OnnxTensorType.html (100%) rename {java => docs/api/java}/ai/onnxruntime/TensorInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/ValueInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/MapInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/NodeInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OnnxJavaType.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OnnxMap.OnnxMapValueType.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OnnxMap.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OnnxSequence.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OnnxTensor.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OnnxValue.OnnxValueType.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OnnxValue.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtEnvironment.LoggingLevel.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtEnvironment.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtException.OrtErrorCode.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtException.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtSession.Result.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtSession.SessionOptions.ExecutionMode.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtSession.SessionOptions.OptLevel.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtSession.SessionOptions.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtSession.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/OrtUtil.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/SequenceInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/TensorInfo.OnnxTensorType.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/TensorInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/class-use/ValueInfo.html (100%) rename {java => docs/api/java}/ai/onnxruntime/package-frame.html (100%) rename {java => docs/api/java}/ai/onnxruntime/package-summary.html (100%) rename {java => docs/api/java}/ai/onnxruntime/package-tree.html (100%) rename {java => docs/api/java}/ai/onnxruntime/package-use.html (100%) rename {java => docs/api/java}/allclasses-frame.html (100%) rename {java => docs/api/java}/allclasses-noframe.html (100%) rename {java => docs/api/java}/constant-values.html (100%) rename {java => docs/api/java}/deprecated-list.html (100%) rename {java => docs/api/java}/help-doc.html (100%) rename {java => docs/api/java}/index-all.html (100%) rename {java => docs/api/java}/index.html (100%) rename {java => docs/api/java}/overview-tree.html (100%) rename {java => docs/api/java}/package-list (100%) rename {java => docs/api/java}/script.js (100%) rename {java => docs/api/java}/serialized-form.html (100%) rename {java => docs/api/java}/stylesheet.css (99%) create mode 100644 docs/api/objectivec-api.md rename {objectivec => docs/api/objectivec}/Classes.html (100%) rename {objectivec => docs/api/objectivec}/Classes/ORTCoreMLExecutionProviderOptions.html (100%) rename {objectivec => docs/api/objectivec}/Classes/ORTEnv.html (100%) rename {objectivec => docs/api/objectivec}/Classes/ORTRunOptions.html (100%) rename {objectivec => docs/api/objectivec}/Classes/ORTSession.html (100%) rename {objectivec => docs/api/objectivec}/Classes/ORTSessionOptions.html (100%) rename {objectivec => docs/api/objectivec}/Classes/ORTTensorTypeAndShapeInfo.html (100%) rename {objectivec => docs/api/objectivec}/Classes/ORTValue.html (100%) rename {objectivec => docs/api/objectivec}/Classes/ORTValueTypeInfo.html (100%) rename {objectivec => docs/api/objectivec}/Enums.html (100%) rename {objectivec => docs/api/objectivec}/Enums/ORTGraphOptimizationLevel.html (100%) rename {objectivec => docs/api/objectivec}/Enums/ORTLoggingLevel.html (100%) rename {objectivec => docs/api/objectivec}/Enums/ORTTensorElementDataType.html (100%) rename {objectivec => docs/api/objectivec}/Enums/ORTValueType.html (100%) rename {objectivec => docs/api/objectivec}/Functions.html (100%) rename {objectivec => docs/api/objectivec}/css/highlight.css (100%) rename {objectivec => docs/api/objectivec}/css/jazzy.css (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Info.plist (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTCoreMLExecutionProviderOptions.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTEnv.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTRunOptions.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSession.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSessionOptions.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTTensorTypeAndShapeInfo.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValue.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValueTypeInfo.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTGraphOptimizationLevel.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTLoggingLevel.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTTensorElementDataType.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTValueType.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Functions.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/highlight.css (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/jazzy.css (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/carat.png (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/dash.png (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/gh.png (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/spinner.gif (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/index.html (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.js (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.search.js (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jquery.min.js (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/lunr.min.js (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/typeahead.jquery.js (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/search.json (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/docSet.dsidx (100%) rename {objectivec => docs/api/objectivec}/docsets/ONNX Runtime Objective-C API.tgz (100%) rename {objectivec => docs/api/objectivec}/img/carat.png (100%) rename {objectivec => docs/api/objectivec}/img/dash.png (100%) rename {objectivec => docs/api/objectivec}/img/gh.png (100%) rename {objectivec => docs/api/objectivec}/img/spinner.gif (100%) rename {objectivec => docs/api/objectivec}/index.html (100%) rename {objectivec => docs/api/objectivec}/js/jazzy.js (100%) rename {objectivec => docs/api/objectivec}/js/jazzy.search.js (100%) rename {objectivec => docs/api/objectivec}/js/jquery.min.js (100%) rename {objectivec => docs/api/objectivec}/js/lunr.min.js (100%) rename {objectivec => docs/api/objectivec}/js/typeahead.jquery.js (100%) rename {objectivec => docs/api/objectivec}/search.json (100%) rename docs/{reference => }/api/other-apis.md (75%) create mode 100644 docs/api/python-api.md rename {python => docs/api/python}/.buildinfo (100%) rename {python => docs/api/python}/.nojekyll (100%) rename {python => docs/api/python}/README.html (100%) rename {python => docs/api/python}/api_summary.html (97%) rename {python => docs/api/python}/auto_examples/index.html (99%) rename {python => docs/api/python}/auto_examples/plot_backend.html (100%) rename {python => docs/api/python}/auto_examples/plot_common_errors.html (100%) rename {python => docs/api/python}/auto_examples/plot_convert_pipeline_vectorizer.html (100%) rename {python => docs/api/python}/auto_examples/plot_dl_keras.html (100%) rename {python => docs/api/python}/auto_examples/plot_load_and_predict.html (100%) rename {python => docs/api/python}/auto_examples/plot_metadata.html (100%) rename {python => docs/api/python}/auto_examples/plot_pipeline.html (100%) rename {python => docs/api/python}/auto_examples/plot_profiling.html (100%) rename {python => docs/api/python}/auto_examples/plot_train_convert_predict.html (100%) rename {python => docs/api/python}/auto_examples/sg_execution_times.html (100%) rename {python => docs/api/python}/downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip (100%) rename {python => docs/api/python}/downloads/1680115d3d937dfbb2d86adb705d9c5d/plot_train_convert_predict.ipynb (100%) rename {python => docs/api/python}/downloads/1b60ac13d6a5a4b72d4e4d28d1544f8d/plot_common_errors.ipynb (100%) rename {python => docs/api/python}/downloads/290d1103c4874727a37c05b400ffb83c/plot_load_and_predict.ipynb (100%) rename {python => docs/api/python}/downloads/2dbd202de70c8b6a394b8a1c7c1e12b8/plot_pipeline.ipynb (100%) rename {python => docs/api/python}/downloads/3a0c2ba94405e579c84b6f356705659d/plot_train_convert_predict.ipynb (100%) rename {python => docs/api/python}/downloads/3a2955e44bf8f95a0eee6e71695ad788/plot_common_errors.py (100%) rename {python => docs/api/python}/downloads/3aca744422de94d33f9aaa3ce99633a9/plot_convert_pipeline_vectorizer.ipynb (100%) rename {python => docs/api/python}/downloads/3e23fa9ebb26f4728ee8426ed7da0f63/plot_backend.py (100%) rename {python => docs/api/python}/downloads/4412ae3bda7068f45094acb5373c790e/plot_load_and_predict.py (100%) rename {python => docs/api/python}/downloads/500c588edb4417e84924953b39d33cc6/plot_convert_pipeline_vectorizer.py (100%) rename {python => docs/api/python}/downloads/594159f58c2d97bee3f22ee659067d5a/plot_backend.ipynb (100%) rename {python => docs/api/python}/downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip (100%) rename {python => docs/api/python}/downloads/7c8424f45d0156abd4d0221c65601124/plot_load_and_predict.py (100%) rename {python => docs/api/python}/downloads/7d69185b02f38811ad5d0593ec22c99d/plot_metadata.py (100%) rename {python => docs/api/python}/downloads/8547b931339c42011a7c05ff3b5f5373/plot_common_errors.py (100%) rename {python => docs/api/python}/downloads/8dd0c9d6c4ab396fa8f24f6321edc4b0/plot_common_errors.ipynb (100%) rename {python => docs/api/python}/downloads/932fe1ee7f48f55a6155d2f378bc85a0/plot_metadata.py (100%) rename {python => docs/api/python}/downloads/940d20a5bdb46eb51fb878fbb3bd928d/plot_metadata.ipynb (100%) rename {python => docs/api/python}/downloads/94ba4b1ad7abc78b59124c6a39f9a075/plot_pipeline.py (100%) rename {python => docs/api/python}/downloads/982a1f7abbb8ffc5d5e98b671c35e5aa/plot_convert_pipeline_vectorizer.py (100%) rename {python => docs/api/python}/downloads/a8a3fe6bdcf0fdfbed17a5a0f2384419/plot_profiling.ipynb (100%) rename {python => docs/api/python}/downloads/ae37e1cd2f800a09b44216a88ac39d30/plot_metadata.ipynb (100%) rename {python => docs/api/python}/downloads/b81c8c31615f9400a26ee60f0641af3f/plot_dl_keras.py (100%) rename {python => docs/api/python}/downloads/be7aeaf8b9b95af92780b5d952019035/plot_convert_pipeline_vectorizer.ipynb (100%) rename {python => docs/api/python}/downloads/c2f3ba3f66159c615632f39a9ad32dee/plot_pipeline.ipynb (100%) rename {python => docs/api/python}/downloads/c647c128e0cf2b3db04ce60b41ef1a14/plot_train_convert_predict.py (100%) rename {python => docs/api/python}/downloads/c9f88a9294285c733dcce209fcc939de/plot_dl_keras.ipynb (100%) rename {python => docs/api/python}/downloads/ccbbfd4f60683438ab99a4c42d3fbbdf/plot_profiling.ipynb (100%) rename {python => docs/api/python}/downloads/cfe61aca1f0a89486c7024466ea500fd/plot_profiling.py (100%) rename {python => docs/api/python}/downloads/d436e9922b51a71358604ec00f09e7e4/plot_pipeline.py (100%) rename {python => docs/api/python}/downloads/d83345a79a181a29892287297803aeec/plot_train_convert_predict.py (100%) rename {python => docs/api/python}/downloads/dee2ae82948a521867a372a6b9515393/plot_load_and_predict.ipynb (100%) rename {python => docs/api/python}/downloads/df88a32237a9b3e764a8da54c1743145/plot_backend.py (100%) rename {python => docs/api/python}/downloads/e4ee07af6afb721729db3bf156693fa2/plot_profiling.py (100%) rename {python => docs/api/python}/downloads/f8e5d8e309ca291f68bd029c26838ccc/plot_backend.ipynb (100%) rename {python => docs/api/python}/examples_md.html (100%) rename {python => docs/api/python}/genindex.html (100%) rename {python => docs/api/python}/images/sphx_glr_plot_backend_thumb.png (100%) rename {python => docs/api/python}/images/sphx_glr_plot_common_errors_thumb.png (100%) rename {python => docs/api/python}/images/sphx_glr_plot_convert_pipeline_vectorizer_thumb.png (100%) rename {python => docs/api/python}/images/sphx_glr_plot_load_and_predict_thumb.png (100%) rename {python => docs/api/python}/images/sphx_glr_plot_metadata_thumb.png (100%) rename {python => docs/api/python}/images/sphx_glr_plot_pipeline_001.png (100%) rename {python => docs/api/python}/images/sphx_glr_plot_pipeline_thumb.png (100%) rename {python => docs/api/python}/images/sphx_glr_plot_profiling_thumb.png (100%) rename {python => docs/api/python}/images/sphx_glr_plot_train_convert_predict_001.png (100%) rename {python => docs/api/python}/images/sphx_glr_plot_train_convert_predict_thumb.png (100%) rename {python => docs/api/python}/index.html (100%) rename {python => docs/api/python}/modules/index.html (100%) rename {python => docs/api/python}/modules/onnxruntime/capi/onnxruntime_inference_collection.html (100%) rename {python => docs/api/python}/modules/onnxruntime/datasets.html (100%) rename {python => docs/api/python}/objects.inv (100%) rename {python => docs/api/python}/search.html (100%) rename {python => docs/api/python}/searchindex.js (100%) rename {python => docs/api/python}/sources/README.rst.txt (100%) rename {python => docs/api/python}/sources/api_summary.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/index.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/plot_backend.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/plot_common_errors.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/plot_convert_pipeline_vectorizer.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/plot_dl_keras.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/plot_load_and_predict.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/plot_metadata.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/plot_pipeline.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/plot_profiling.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/plot_train_convert_predict.rst.txt (100%) rename {python => docs/api/python}/sources/auto_examples/sg_execution_times.rst.txt (100%) rename {python => docs/api/python}/sources/examples_md.rst.txt (100%) rename {python => docs/api/python}/sources/index.rst.txt (100%) rename {python => docs/api/python}/sources/tutorial.rst.txt (100%) rename {python => docs/api/python}/static/ONNX_Runtime_icon.png (100%) rename {python => docs/api/python}/static/alabaster.css (100%) rename {python => docs/api/python}/static/basic.css (100%) rename {python => docs/api/python}/static/binder_badge_logo.svg (100%) rename {python => docs/api/python}/static/broken_example.png (100%) rename {python => docs/api/python}/static/custom.css (100%) rename {python => docs/api/python}/static/doctools.js (100%) rename {python => docs/api/python}/static/documentation_options.js (100%) rename {python => docs/api/python}/static/file.png (100%) rename {python => docs/api/python}/static/gallery-binder.css (100%) rename {python => docs/api/python}/static/gallery-dataframe.css (100%) rename {python => docs/api/python}/static/gallery-rendered-html.css (100%) rename {python => docs/api/python}/static/gallery.css (100%) rename {python => docs/api/python}/static/graphviz.css (100%) rename {python => docs/api/python}/static/jquery-3.5.1.js (100%) rename {python => docs/api/python}/static/jquery.js (100%) rename {python => docs/api/python}/static/language_data.js (100%) rename {python => docs/api/python}/static/minus.png (100%) rename {python => docs/api/python}/static/no_image.png (100%) rename {python => docs/api/python}/static/plus.png (100%) rename {python => docs/api/python}/static/pygments.css (100%) rename {python => docs/api/python}/static/searchtools.js (100%) rename {python => docs/api/python}/static/underscore-1.12.0.js (100%) rename {python => docs/api/python}/static/underscore-1.3.1.js (100%) rename {python => docs/api/python}/static/underscore.js (100%) rename {python => docs/api/python}/tutorial.html (100%) create mode 100644 docs/api/winrt-api.md rename docs/{how-to => }/build/android-ios.md (97%) rename docs/{how-to => }/build/eps.md (95%) rename docs/{how-to => }/build/index.md (89%) rename docs/{how-to => }/build/inferencing.md (99%) rename docs/{how-to => }/build/reduced.md (99%) rename docs/{how-to => }/build/training.md (99%) create mode 100644 docs/build/web.md rename docs/{tutorials/ecosystem.md => ecosystem/index.md} (78%) rename docs/{reference => }/execution-providers/ACL-ExecutionProvider.md (53%) rename docs/{reference => }/execution-providers/ArmNN-ExecutionProvider.md (82%) rename docs/{reference => }/execution-providers/CUDA-ExecutionProvider.md (95%) rename docs/{reference => }/execution-providers/CoreML-ExecutionProvider.md (96%) rename docs/{reference => }/execution-providers/DirectML-ExecutionProvider.md (94%) rename docs/{reference => }/execution-providers/MIGraphX-ExecutionProvider.md (87%) rename docs/{reference => }/execution-providers/NNAPI-ExecutionProvider.md (94%) rename docs/{reference => }/execution-providers/Nuphar-ExecutionProvider.md (99%) rename docs/{reference => }/execution-providers/OpenVINO-ExecutionProvider.md (96%) rename docs/{reference => }/execution-providers/RKNPU-ExecutionProvider.md (91%) rename docs/{reference => }/execution-providers/TensorRT-ExecutionProvider.md (98%) rename docs/{reference => }/execution-providers/Vitis-AI-ExecutionProvider.md (98%) rename docs/{how-to => execution-providers}/add-execution-provider.md (98%) rename docs/{reference => }/execution-providers/index.md (96%) rename docs/{reference => }/execution-providers/oneDNN-ExecutionProvider.md (95%) create mode 100644 docs/get-started/index.md create mode 100644 docs/get-started/training-pytorch.md rename docs/{reference/api/c-api.md => get-started/with-c.md} (97%) rename docs/{reference/api/cpp-api.md => get-started/with-cpp.md} (76%) rename docs/{reference/api/csharp-api.md => get-started/with-csharp.md} (54%) create mode 100644 docs/get-started/with-iot.md rename docs/{reference/api/java-api.md => get-started/with-java.md} (98%) create mode 100644 docs/get-started/with-javascript.md create mode 100644 docs/get-started/with-mobile.md rename docs/{reference/api/objectivec-api.md => get-started/with-obj-c.md} (73%) create mode 100644 docs/get-started/with-python.md rename docs/{reference/api/winrt-api.md => get-started/with-winrt.md} (91%) delete mode 100644 docs/how-to/build/web.md delete mode 100644 docs/how-to/index.md rename docs/{how-to/install.md => install/index.md} (66%) rename docs/{resources => performance}/graph-optimizations.md (99%) create mode 100644 docs/performance/index.md rename docs/{resources => performance}/mobile-performance-tuning.md (94%) rename docs/{how-to => performance}/quantization.md (99%) rename docs/{how-to => performance}/tune-performance.md (97%) delete mode 100644 docs/reference/api/index.md delete mode 100644 docs/reference/api/js-api.md delete mode 100644 docs/reference/api/python-api.md delete mode 100644 docs/reference/api/training-pytorch.md rename docs/{resources => reference}/compatibility.md (97%) rename docs/{resources => reference}/high-level-design.md (96%) rename docs/{how-to => reference/operators}/add-custom-op.md (99%) rename docs/{how-to => reference/operators}/custom-python-operator.md (99%) delete mode 100644 docs/resources/index.md rename docs/tutorials/{tutorials => }/OpenVINO_EP_samples/squeezenet_classification_cpp.md (100%) rename docs/tutorials/{tutorials => }/OpenVINO_EP_samples/tiny_yolo_v2_object_detection_python.md (100%) rename docs/tutorials/{tutorials => }/OpenVINO_EP_samples/yolov3_object_detection_csharp.md (100%) create mode 100644 docs/tutorials/accelerate-pytorch/index.md rename docs/tutorials/{training => accelerate-pytorch}/ort-training.md (90%) rename docs/tutorials/{inferencing => accelerate-pytorch}/pytorch.md (88%) rename docs/tutorials/{inferencing => }/api-basics.md (96%) rename docs/tutorials/{tutorials => }/basic_csharp.md (100%) rename docs/tutorials/{tutorials => }/export-pytorch-model.md (100%) rename docs/tutorials/{tutorials => }/fasterrcnn_csharp.md (100%) rename docs/tutorials/{inferencing => }/huggingface.md (96%) delete mode 100644 docs/tutorials/inferencing/index.md delete mode 100644 docs/tutorials/inferencing/web.md rename docs/tutorials/{inferencing => }/iot-edge.md (90%) rename docs/tutorials/{tutorials => }/mnist_cpp.md (100%) rename docs/tutorials/{tutorials => }/mnist_java.md (100%) rename docs/tutorials/{inferencing => }/mobile.md (74%) rename docs/{how-to => tutorials}/mobile/custom-build.md (99%) rename docs/{how-to => tutorials}/mobile/index.md (86%) rename docs/{how-to => tutorials}/mobile/initial-setup.md (99%) rename docs/{how-to => tutorials}/mobile/limitations.md (98%) rename docs/{how-to => tutorials}/mobile/model-conversion.md (98%) rename docs/{how-to => tutorials}/mobile/model-execution.md (92%) rename docs/{how-to => tutorials}/mobile/overview.md (94%) rename docs/{how-to => tutorials}/mobile/using-nnapi-coreml-with-ort-mobile.md (88%) rename docs/tutorials/{tutorials => }/resnet50_csharp.md (100%) rename docs/tutorials/{inferencing => }/tensorflow.md (95%) rename docs/tutorials/{tutorials => }/tf-get-started.md (96%) rename docs/tutorials/{inferencing => }/traditional-ml.md (95%) delete mode 100644 docs/tutorials/training/docs - Shortcut.lnk delete mode 100644 docs/tutorials/training/index.md create mode 100644 docs/tutorials/web.md diff --git a/.gitignore b/.gitignore index d5690d8d20..decd97e7ef 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ _site .sass-cache .jekyll-metadata *.out +.venv # direnv, posh-direnv .envrc diff --git a/_config.yml b/_config.yml index 246af39127..13bc44e3bf 100644 --- a/_config.yml +++ b/_config.yml @@ -11,15 +11,18 @@ kramdown: parse_block_html: true toc_levels: "1,2,3" logo: "/images/ONNX-Runtime-logo.svg" -aux_links: +aux_links: + + "Onnx Runtime": + - "/" + "Install": + - "/docs/install/" + "Get Started": + - "/docs/get-started/" "Tutorials": - "/docs/tutorials/" - "How to": - - "/docs/how-to/" - "Reference": - - "/docs/reference/" - "Resources": - - "/docs/resources/" + "API Docs": + - "/docs/api/" "GitHub": - "https://github.com/microsoft/onnxruntime" ga_tracking: UA-156955408-1 diff --git a/about.html b/about.html index 64562c58b1..6a3ce251d3 100644 --- a/about.html +++ b/about.html @@ -88,7 +88,7 @@

Optimization and acceleration

- Run any ONNX model using a single set of inference APIs that provide access to the best hardware acceleration available. Built-in optimization features trim and consolidate nodes without impacting model accuracy. Additionally, full backwards compatibility for ONNX and ONNX-ML ensures all ONNX models can be inferenced. + Run any ONNX model using a single set of inference APIs that provide access to the best hardware acceleration available. Built-in optimization features trim and consolidate nodes without impacting model accuracy. Additionally, full backwards compatibility for ONNX and ONNX-ML ensures all ONNX models can be inferenced.

@@ -99,7 +99,7 @@

API and platform support

- Take advantage of the benefits of ONNX Runtime without changing your technology stack. Access ONNX Runtime using your preferred APIC#, C++, C, Python, or Java. Support for Linux, Windows and Mac allows you to build and deploy applications without worry. + Take advantage of the benefits of ONNX Runtime without changing your technology stack. Access ONNX Runtime using your preferred APIC#, C++, C, Python, or Java. Support for Linux, Windows and Mac allows you to build and deploy applications without worry.

@@ -173,7 +173,7 @@ Tutorials
  • - + APIs
  • diff --git a/docs/reference/api/csharp-api-reference.md b/docs/api/csharp-api.md similarity index 97% rename from docs/reference/api/csharp-api-reference.md rename to docs/api/csharp-api.md index 2f6e392c8c..17c14ae3da 100644 --- a/docs/reference/api/csharp-api-reference.md +++ b/docs/api/csharp-api.md @@ -1,8 +1,11 @@ --- -nav_exclude: true +title: C# API +parent: API Docs +nav_order: 2 --- # C# API Reference +{: .no_toc } ### OrtEnv ```cs @@ -149,7 +152,7 @@ SetSessionExecutionMode(ExecutionMode execution_mode); ``` * ORT_SEQUENTIAL - execute operators in the graph sequentially. * ORT_PARALLEL - execute operators in the graph in parallel. -See [How to tune performance](../../how-to/tune-performance.md) for more details. +See [How to tune performance](../performance/tune-performance.md) for more details. ### NodeMetadata Container of metadata for a model graph node, used for communicating the shape and type of the input and output nodes. diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000000..b090fd3497 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,15 @@ +--- +title: API Docs +has_children: true +nav_order: 5 +--- +# ORT API docs +{: .no_toc } + +|:----------------------------------------------------------------------------------| +| [Python API Docs](./python/api_summary.html){: .btn } | +| [Java API Docs](./java/index.html){: .btn} | +| [Objective C Docs](./objectivec/index.html){: .btn} | +| [WinRT API Docs](https://docs.microsoft.com/windows/ai/windows-ml/api-reference){: .btn} | +| [C# API Docs](./csharp-api){: .btn} | +| [Other API Docs](./other-apis){: .btn} | \ No newline at end of file diff --git a/docs/api/java-api.md b/docs/api/java-api.md new file mode 100644 index 0000000000..ddbc83a4a0 --- /dev/null +++ b/docs/api/java-api.md @@ -0,0 +1,10 @@ +--- +title: Java API +parent: API Docs +nav_order: 3 +--- + +# ORT Java Docs +{: .no_toc } + + [Go to the Java Docs](./java/index.html){: .btn .mr-4 target="_blank"} diff --git a/java/ai/onnxruntime/MapInfo.html b/docs/api/java/ai/onnxruntime/MapInfo.html similarity index 100% rename from java/ai/onnxruntime/MapInfo.html rename to docs/api/java/ai/onnxruntime/MapInfo.html diff --git a/java/ai/onnxruntime/NodeInfo.html b/docs/api/java/ai/onnxruntime/NodeInfo.html similarity index 100% rename from java/ai/onnxruntime/NodeInfo.html rename to docs/api/java/ai/onnxruntime/NodeInfo.html diff --git a/java/ai/onnxruntime/OnnxJavaType.html b/docs/api/java/ai/onnxruntime/OnnxJavaType.html similarity index 100% rename from java/ai/onnxruntime/OnnxJavaType.html rename to docs/api/java/ai/onnxruntime/OnnxJavaType.html diff --git a/java/ai/onnxruntime/OnnxMap.OnnxMapValueType.html b/docs/api/java/ai/onnxruntime/OnnxMap.OnnxMapValueType.html similarity index 100% rename from java/ai/onnxruntime/OnnxMap.OnnxMapValueType.html rename to docs/api/java/ai/onnxruntime/OnnxMap.OnnxMapValueType.html diff --git a/java/ai/onnxruntime/OnnxMap.html b/docs/api/java/ai/onnxruntime/OnnxMap.html similarity index 100% rename from java/ai/onnxruntime/OnnxMap.html rename to docs/api/java/ai/onnxruntime/OnnxMap.html diff --git a/java/ai/onnxruntime/OnnxSequence.html b/docs/api/java/ai/onnxruntime/OnnxSequence.html similarity index 100% rename from java/ai/onnxruntime/OnnxSequence.html rename to docs/api/java/ai/onnxruntime/OnnxSequence.html diff --git a/java/ai/onnxruntime/OnnxTensor.html b/docs/api/java/ai/onnxruntime/OnnxTensor.html similarity index 100% rename from java/ai/onnxruntime/OnnxTensor.html rename to docs/api/java/ai/onnxruntime/OnnxTensor.html diff --git a/java/ai/onnxruntime/OnnxValue.OnnxValueType.html b/docs/api/java/ai/onnxruntime/OnnxValue.OnnxValueType.html similarity index 100% rename from java/ai/onnxruntime/OnnxValue.OnnxValueType.html rename to docs/api/java/ai/onnxruntime/OnnxValue.OnnxValueType.html diff --git a/java/ai/onnxruntime/OnnxValue.html b/docs/api/java/ai/onnxruntime/OnnxValue.html similarity index 100% rename from java/ai/onnxruntime/OnnxValue.html rename to docs/api/java/ai/onnxruntime/OnnxValue.html diff --git a/java/ai/onnxruntime/OrtEnvironment.LoggingLevel.html b/docs/api/java/ai/onnxruntime/OrtEnvironment.LoggingLevel.html similarity index 100% rename from java/ai/onnxruntime/OrtEnvironment.LoggingLevel.html rename to docs/api/java/ai/onnxruntime/OrtEnvironment.LoggingLevel.html diff --git a/java/ai/onnxruntime/OrtEnvironment.html b/docs/api/java/ai/onnxruntime/OrtEnvironment.html similarity index 100% rename from java/ai/onnxruntime/OrtEnvironment.html rename to docs/api/java/ai/onnxruntime/OrtEnvironment.html diff --git a/java/ai/onnxruntime/OrtException.OrtErrorCode.html b/docs/api/java/ai/onnxruntime/OrtException.OrtErrorCode.html similarity index 100% rename from java/ai/onnxruntime/OrtException.OrtErrorCode.html rename to docs/api/java/ai/onnxruntime/OrtException.OrtErrorCode.html diff --git a/java/ai/onnxruntime/OrtException.html b/docs/api/java/ai/onnxruntime/OrtException.html similarity index 100% rename from java/ai/onnxruntime/OrtException.html rename to docs/api/java/ai/onnxruntime/OrtException.html diff --git a/java/ai/onnxruntime/OrtSession.Result.html b/docs/api/java/ai/onnxruntime/OrtSession.Result.html similarity index 100% rename from java/ai/onnxruntime/OrtSession.Result.html rename to docs/api/java/ai/onnxruntime/OrtSession.Result.html diff --git a/java/ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html b/docs/api/java/ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html similarity index 100% rename from java/ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html rename to docs/api/java/ai/onnxruntime/OrtSession.SessionOptions.ExecutionMode.html diff --git a/java/ai/onnxruntime/OrtSession.SessionOptions.OptLevel.html b/docs/api/java/ai/onnxruntime/OrtSession.SessionOptions.OptLevel.html similarity index 100% rename from java/ai/onnxruntime/OrtSession.SessionOptions.OptLevel.html rename to docs/api/java/ai/onnxruntime/OrtSession.SessionOptions.OptLevel.html diff --git a/java/ai/onnxruntime/OrtSession.SessionOptions.html b/docs/api/java/ai/onnxruntime/OrtSession.SessionOptions.html similarity index 100% rename from java/ai/onnxruntime/OrtSession.SessionOptions.html rename to docs/api/java/ai/onnxruntime/OrtSession.SessionOptions.html diff --git a/java/ai/onnxruntime/OrtSession.html b/docs/api/java/ai/onnxruntime/OrtSession.html similarity index 100% rename from java/ai/onnxruntime/OrtSession.html rename to docs/api/java/ai/onnxruntime/OrtSession.html diff --git a/java/ai/onnxruntime/OrtUtil.html b/docs/api/java/ai/onnxruntime/OrtUtil.html similarity index 100% rename from java/ai/onnxruntime/OrtUtil.html rename to docs/api/java/ai/onnxruntime/OrtUtil.html diff --git a/java/ai/onnxruntime/SequenceInfo.html b/docs/api/java/ai/onnxruntime/SequenceInfo.html similarity index 100% rename from java/ai/onnxruntime/SequenceInfo.html rename to docs/api/java/ai/onnxruntime/SequenceInfo.html diff --git a/java/ai/onnxruntime/TensorInfo.OnnxTensorType.html b/docs/api/java/ai/onnxruntime/TensorInfo.OnnxTensorType.html similarity index 100% rename from java/ai/onnxruntime/TensorInfo.OnnxTensorType.html rename to docs/api/java/ai/onnxruntime/TensorInfo.OnnxTensorType.html diff --git a/java/ai/onnxruntime/TensorInfo.html b/docs/api/java/ai/onnxruntime/TensorInfo.html similarity index 100% rename from java/ai/onnxruntime/TensorInfo.html rename to docs/api/java/ai/onnxruntime/TensorInfo.html diff --git a/java/ai/onnxruntime/ValueInfo.html b/docs/api/java/ai/onnxruntime/ValueInfo.html similarity index 100% rename from java/ai/onnxruntime/ValueInfo.html rename to docs/api/java/ai/onnxruntime/ValueInfo.html diff --git a/java/ai/onnxruntime/class-use/MapInfo.html b/docs/api/java/ai/onnxruntime/class-use/MapInfo.html similarity index 100% rename from java/ai/onnxruntime/class-use/MapInfo.html rename to docs/api/java/ai/onnxruntime/class-use/MapInfo.html diff --git a/java/ai/onnxruntime/class-use/NodeInfo.html b/docs/api/java/ai/onnxruntime/class-use/NodeInfo.html similarity index 100% rename from java/ai/onnxruntime/class-use/NodeInfo.html rename to docs/api/java/ai/onnxruntime/class-use/NodeInfo.html diff --git a/java/ai/onnxruntime/class-use/OnnxJavaType.html b/docs/api/java/ai/onnxruntime/class-use/OnnxJavaType.html similarity index 100% rename from java/ai/onnxruntime/class-use/OnnxJavaType.html rename to docs/api/java/ai/onnxruntime/class-use/OnnxJavaType.html diff --git a/java/ai/onnxruntime/class-use/OnnxMap.OnnxMapValueType.html b/docs/api/java/ai/onnxruntime/class-use/OnnxMap.OnnxMapValueType.html similarity index 100% rename from java/ai/onnxruntime/class-use/OnnxMap.OnnxMapValueType.html rename to docs/api/java/ai/onnxruntime/class-use/OnnxMap.OnnxMapValueType.html diff --git a/java/ai/onnxruntime/class-use/OnnxMap.html b/docs/api/java/ai/onnxruntime/class-use/OnnxMap.html similarity index 100% rename from java/ai/onnxruntime/class-use/OnnxMap.html rename to docs/api/java/ai/onnxruntime/class-use/OnnxMap.html diff --git a/java/ai/onnxruntime/class-use/OnnxSequence.html b/docs/api/java/ai/onnxruntime/class-use/OnnxSequence.html similarity index 100% rename from java/ai/onnxruntime/class-use/OnnxSequence.html rename to docs/api/java/ai/onnxruntime/class-use/OnnxSequence.html diff --git a/java/ai/onnxruntime/class-use/OnnxTensor.html b/docs/api/java/ai/onnxruntime/class-use/OnnxTensor.html similarity index 100% rename from java/ai/onnxruntime/class-use/OnnxTensor.html rename to docs/api/java/ai/onnxruntime/class-use/OnnxTensor.html diff --git a/java/ai/onnxruntime/class-use/OnnxValue.OnnxValueType.html b/docs/api/java/ai/onnxruntime/class-use/OnnxValue.OnnxValueType.html similarity index 100% rename from java/ai/onnxruntime/class-use/OnnxValue.OnnxValueType.html rename to docs/api/java/ai/onnxruntime/class-use/OnnxValue.OnnxValueType.html diff --git a/java/ai/onnxruntime/class-use/OnnxValue.html b/docs/api/java/ai/onnxruntime/class-use/OnnxValue.html similarity index 100% rename from java/ai/onnxruntime/class-use/OnnxValue.html rename to docs/api/java/ai/onnxruntime/class-use/OnnxValue.html diff --git a/java/ai/onnxruntime/class-use/OrtEnvironment.LoggingLevel.html b/docs/api/java/ai/onnxruntime/class-use/OrtEnvironment.LoggingLevel.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtEnvironment.LoggingLevel.html rename to docs/api/java/ai/onnxruntime/class-use/OrtEnvironment.LoggingLevel.html diff --git a/java/ai/onnxruntime/class-use/OrtEnvironment.html b/docs/api/java/ai/onnxruntime/class-use/OrtEnvironment.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtEnvironment.html rename to docs/api/java/ai/onnxruntime/class-use/OrtEnvironment.html diff --git a/java/ai/onnxruntime/class-use/OrtException.OrtErrorCode.html b/docs/api/java/ai/onnxruntime/class-use/OrtException.OrtErrorCode.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtException.OrtErrorCode.html rename to docs/api/java/ai/onnxruntime/class-use/OrtException.OrtErrorCode.html diff --git a/java/ai/onnxruntime/class-use/OrtException.html b/docs/api/java/ai/onnxruntime/class-use/OrtException.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtException.html rename to docs/api/java/ai/onnxruntime/class-use/OrtException.html diff --git a/java/ai/onnxruntime/class-use/OrtSession.Result.html b/docs/api/java/ai/onnxruntime/class-use/OrtSession.Result.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtSession.Result.html rename to docs/api/java/ai/onnxruntime/class-use/OrtSession.Result.html diff --git a/java/ai/onnxruntime/class-use/OrtSession.SessionOptions.ExecutionMode.html b/docs/api/java/ai/onnxruntime/class-use/OrtSession.SessionOptions.ExecutionMode.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtSession.SessionOptions.ExecutionMode.html rename to docs/api/java/ai/onnxruntime/class-use/OrtSession.SessionOptions.ExecutionMode.html diff --git a/java/ai/onnxruntime/class-use/OrtSession.SessionOptions.OptLevel.html b/docs/api/java/ai/onnxruntime/class-use/OrtSession.SessionOptions.OptLevel.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtSession.SessionOptions.OptLevel.html rename to docs/api/java/ai/onnxruntime/class-use/OrtSession.SessionOptions.OptLevel.html diff --git a/java/ai/onnxruntime/class-use/OrtSession.SessionOptions.html b/docs/api/java/ai/onnxruntime/class-use/OrtSession.SessionOptions.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtSession.SessionOptions.html rename to docs/api/java/ai/onnxruntime/class-use/OrtSession.SessionOptions.html diff --git a/java/ai/onnxruntime/class-use/OrtSession.html b/docs/api/java/ai/onnxruntime/class-use/OrtSession.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtSession.html rename to docs/api/java/ai/onnxruntime/class-use/OrtSession.html diff --git a/java/ai/onnxruntime/class-use/OrtUtil.html b/docs/api/java/ai/onnxruntime/class-use/OrtUtil.html similarity index 100% rename from java/ai/onnxruntime/class-use/OrtUtil.html rename to docs/api/java/ai/onnxruntime/class-use/OrtUtil.html diff --git a/java/ai/onnxruntime/class-use/SequenceInfo.html b/docs/api/java/ai/onnxruntime/class-use/SequenceInfo.html similarity index 100% rename from java/ai/onnxruntime/class-use/SequenceInfo.html rename to docs/api/java/ai/onnxruntime/class-use/SequenceInfo.html diff --git a/java/ai/onnxruntime/class-use/TensorInfo.OnnxTensorType.html b/docs/api/java/ai/onnxruntime/class-use/TensorInfo.OnnxTensorType.html similarity index 100% rename from java/ai/onnxruntime/class-use/TensorInfo.OnnxTensorType.html rename to docs/api/java/ai/onnxruntime/class-use/TensorInfo.OnnxTensorType.html diff --git a/java/ai/onnxruntime/class-use/TensorInfo.html b/docs/api/java/ai/onnxruntime/class-use/TensorInfo.html similarity index 100% rename from java/ai/onnxruntime/class-use/TensorInfo.html rename to docs/api/java/ai/onnxruntime/class-use/TensorInfo.html diff --git a/java/ai/onnxruntime/class-use/ValueInfo.html b/docs/api/java/ai/onnxruntime/class-use/ValueInfo.html similarity index 100% rename from java/ai/onnxruntime/class-use/ValueInfo.html rename to docs/api/java/ai/onnxruntime/class-use/ValueInfo.html diff --git a/java/ai/onnxruntime/package-frame.html b/docs/api/java/ai/onnxruntime/package-frame.html similarity index 100% rename from java/ai/onnxruntime/package-frame.html rename to docs/api/java/ai/onnxruntime/package-frame.html diff --git a/java/ai/onnxruntime/package-summary.html b/docs/api/java/ai/onnxruntime/package-summary.html similarity index 100% rename from java/ai/onnxruntime/package-summary.html rename to docs/api/java/ai/onnxruntime/package-summary.html diff --git a/java/ai/onnxruntime/package-tree.html b/docs/api/java/ai/onnxruntime/package-tree.html similarity index 100% rename from java/ai/onnxruntime/package-tree.html rename to docs/api/java/ai/onnxruntime/package-tree.html diff --git a/java/ai/onnxruntime/package-use.html b/docs/api/java/ai/onnxruntime/package-use.html similarity index 100% rename from java/ai/onnxruntime/package-use.html rename to docs/api/java/ai/onnxruntime/package-use.html diff --git a/java/allclasses-frame.html b/docs/api/java/allclasses-frame.html similarity index 100% rename from java/allclasses-frame.html rename to docs/api/java/allclasses-frame.html diff --git a/java/allclasses-noframe.html b/docs/api/java/allclasses-noframe.html similarity index 100% rename from java/allclasses-noframe.html rename to docs/api/java/allclasses-noframe.html diff --git a/java/constant-values.html b/docs/api/java/constant-values.html similarity index 100% rename from java/constant-values.html rename to docs/api/java/constant-values.html diff --git a/java/deprecated-list.html b/docs/api/java/deprecated-list.html similarity index 100% rename from java/deprecated-list.html rename to docs/api/java/deprecated-list.html diff --git a/java/help-doc.html b/docs/api/java/help-doc.html similarity index 100% rename from java/help-doc.html rename to docs/api/java/help-doc.html diff --git a/java/index-all.html b/docs/api/java/index-all.html similarity index 100% rename from java/index-all.html rename to docs/api/java/index-all.html diff --git a/java/index.html b/docs/api/java/index.html similarity index 100% rename from java/index.html rename to docs/api/java/index.html diff --git a/java/overview-tree.html b/docs/api/java/overview-tree.html similarity index 100% rename from java/overview-tree.html rename to docs/api/java/overview-tree.html diff --git a/java/package-list b/docs/api/java/package-list similarity index 100% rename from java/package-list rename to docs/api/java/package-list diff --git a/java/script.js b/docs/api/java/script.js similarity index 100% rename from java/script.js rename to docs/api/java/script.js diff --git a/java/serialized-form.html b/docs/api/java/serialized-form.html similarity index 100% rename from java/serialized-form.html rename to docs/api/java/serialized-form.html diff --git a/java/stylesheet.css b/docs/api/java/stylesheet.css similarity index 99% rename from java/stylesheet.css rename to docs/api/java/stylesheet.css index 98055b22d6..9adb3c7cae 100644 --- a/java/stylesheet.css +++ b/docs/api/java/stylesheet.css @@ -3,7 +3,7 @@ Overall document style */ -@import url('resources/fonts/dejavu.css'); +@import url('../../../resources/fonts/dejavu.css'); body { background-color:#ffffff; diff --git a/docs/api/objectivec-api.md b/docs/api/objectivec-api.md new file mode 100644 index 0000000000..a8322f6be3 --- /dev/null +++ b/docs/api/objectivec-api.md @@ -0,0 +1,10 @@ +--- +title: Objective-C API +parent: API Docs +nav_order: 4 +--- + +# ORT Objective-C Docs +{: .no_toc } + + [Go to the Objective-C Docs](./objectivec/index.html){: .btn .mr-4 target="_blank"} diff --git a/objectivec/Classes.html b/docs/api/objectivec/Classes.html similarity index 100% rename from objectivec/Classes.html rename to docs/api/objectivec/Classes.html diff --git a/objectivec/Classes/ORTCoreMLExecutionProviderOptions.html b/docs/api/objectivec/Classes/ORTCoreMLExecutionProviderOptions.html similarity index 100% rename from objectivec/Classes/ORTCoreMLExecutionProviderOptions.html rename to docs/api/objectivec/Classes/ORTCoreMLExecutionProviderOptions.html diff --git a/objectivec/Classes/ORTEnv.html b/docs/api/objectivec/Classes/ORTEnv.html similarity index 100% rename from objectivec/Classes/ORTEnv.html rename to docs/api/objectivec/Classes/ORTEnv.html diff --git a/objectivec/Classes/ORTRunOptions.html b/docs/api/objectivec/Classes/ORTRunOptions.html similarity index 100% rename from objectivec/Classes/ORTRunOptions.html rename to docs/api/objectivec/Classes/ORTRunOptions.html diff --git a/objectivec/Classes/ORTSession.html b/docs/api/objectivec/Classes/ORTSession.html similarity index 100% rename from objectivec/Classes/ORTSession.html rename to docs/api/objectivec/Classes/ORTSession.html diff --git a/objectivec/Classes/ORTSessionOptions.html b/docs/api/objectivec/Classes/ORTSessionOptions.html similarity index 100% rename from objectivec/Classes/ORTSessionOptions.html rename to docs/api/objectivec/Classes/ORTSessionOptions.html diff --git a/objectivec/Classes/ORTTensorTypeAndShapeInfo.html b/docs/api/objectivec/Classes/ORTTensorTypeAndShapeInfo.html similarity index 100% rename from objectivec/Classes/ORTTensorTypeAndShapeInfo.html rename to docs/api/objectivec/Classes/ORTTensorTypeAndShapeInfo.html diff --git a/objectivec/Classes/ORTValue.html b/docs/api/objectivec/Classes/ORTValue.html similarity index 100% rename from objectivec/Classes/ORTValue.html rename to docs/api/objectivec/Classes/ORTValue.html diff --git a/objectivec/Classes/ORTValueTypeInfo.html b/docs/api/objectivec/Classes/ORTValueTypeInfo.html similarity index 100% rename from objectivec/Classes/ORTValueTypeInfo.html rename to docs/api/objectivec/Classes/ORTValueTypeInfo.html diff --git a/objectivec/Enums.html b/docs/api/objectivec/Enums.html similarity index 100% rename from objectivec/Enums.html rename to docs/api/objectivec/Enums.html diff --git a/objectivec/Enums/ORTGraphOptimizationLevel.html b/docs/api/objectivec/Enums/ORTGraphOptimizationLevel.html similarity index 100% rename from objectivec/Enums/ORTGraphOptimizationLevel.html rename to docs/api/objectivec/Enums/ORTGraphOptimizationLevel.html diff --git a/objectivec/Enums/ORTLoggingLevel.html b/docs/api/objectivec/Enums/ORTLoggingLevel.html similarity index 100% rename from objectivec/Enums/ORTLoggingLevel.html rename to docs/api/objectivec/Enums/ORTLoggingLevel.html diff --git a/objectivec/Enums/ORTTensorElementDataType.html b/docs/api/objectivec/Enums/ORTTensorElementDataType.html similarity index 100% rename from objectivec/Enums/ORTTensorElementDataType.html rename to docs/api/objectivec/Enums/ORTTensorElementDataType.html diff --git a/objectivec/Enums/ORTValueType.html b/docs/api/objectivec/Enums/ORTValueType.html similarity index 100% rename from objectivec/Enums/ORTValueType.html rename to docs/api/objectivec/Enums/ORTValueType.html diff --git a/objectivec/Functions.html b/docs/api/objectivec/Functions.html similarity index 100% rename from objectivec/Functions.html rename to docs/api/objectivec/Functions.html diff --git a/objectivec/css/highlight.css b/docs/api/objectivec/css/highlight.css similarity index 100% rename from objectivec/css/highlight.css rename to docs/api/objectivec/css/highlight.css diff --git a/objectivec/css/jazzy.css b/docs/api/objectivec/css/jazzy.css similarity index 100% rename from objectivec/css/jazzy.css rename to docs/api/objectivec/css/jazzy.css diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Info.plist b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Info.plist similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Info.plist rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Info.plist diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTCoreMLExecutionProviderOptions.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTCoreMLExecutionProviderOptions.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTCoreMLExecutionProviderOptions.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTCoreMLExecutionProviderOptions.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTEnv.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTEnv.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTEnv.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTEnv.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTRunOptions.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTRunOptions.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTRunOptions.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTRunOptions.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSession.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSession.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSession.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSession.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSessionOptions.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSessionOptions.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSessionOptions.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTSessionOptions.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTTensorTypeAndShapeInfo.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTTensorTypeAndShapeInfo.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTTensorTypeAndShapeInfo.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTTensorTypeAndShapeInfo.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValue.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValue.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValue.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValue.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValueTypeInfo.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValueTypeInfo.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValueTypeInfo.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Classes/ORTValueTypeInfo.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTGraphOptimizationLevel.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTGraphOptimizationLevel.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTGraphOptimizationLevel.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTGraphOptimizationLevel.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTLoggingLevel.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTLoggingLevel.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTLoggingLevel.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTLoggingLevel.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTTensorElementDataType.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTTensorElementDataType.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTTensorElementDataType.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTTensorElementDataType.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTValueType.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTValueType.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTValueType.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Enums/ORTValueType.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Functions.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Functions.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Functions.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/Functions.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/highlight.css b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/highlight.css similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/highlight.css rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/highlight.css diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/jazzy.css b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/jazzy.css similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/jazzy.css rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/css/jazzy.css diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/carat.png b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/carat.png similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/carat.png rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/carat.png diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/dash.png b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/dash.png similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/dash.png rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/dash.png diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/gh.png b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/gh.png similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/gh.png rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/gh.png diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/spinner.gif b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/spinner.gif similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/spinner.gif rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/img/spinner.gif diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/index.html b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/index.html similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/index.html rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/index.html diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.js b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.js similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.js rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.js diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.search.js b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.search.js similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.search.js rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jazzy.search.js diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jquery.min.js b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jquery.min.js similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jquery.min.js rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/jquery.min.js diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/lunr.min.js b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/lunr.min.js similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/lunr.min.js rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/lunr.min.js diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/typeahead.jquery.js b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/typeahead.jquery.js similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/typeahead.jquery.js rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/js/typeahead.jquery.js diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/search.json b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/search.json similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/search.json rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/Documents/search.json diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/docSet.dsidx b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/docSet.dsidx similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/docSet.dsidx rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.docset/Contents/Resources/docSet.dsidx diff --git a/objectivec/docsets/ONNX Runtime Objective-C API.tgz b/docs/api/objectivec/docsets/ONNX Runtime Objective-C API.tgz similarity index 100% rename from objectivec/docsets/ONNX Runtime Objective-C API.tgz rename to docs/api/objectivec/docsets/ONNX Runtime Objective-C API.tgz diff --git a/objectivec/img/carat.png b/docs/api/objectivec/img/carat.png similarity index 100% rename from objectivec/img/carat.png rename to docs/api/objectivec/img/carat.png diff --git a/objectivec/img/dash.png b/docs/api/objectivec/img/dash.png similarity index 100% rename from objectivec/img/dash.png rename to docs/api/objectivec/img/dash.png diff --git a/objectivec/img/gh.png b/docs/api/objectivec/img/gh.png similarity index 100% rename from objectivec/img/gh.png rename to docs/api/objectivec/img/gh.png diff --git a/objectivec/img/spinner.gif b/docs/api/objectivec/img/spinner.gif similarity index 100% rename from objectivec/img/spinner.gif rename to docs/api/objectivec/img/spinner.gif diff --git a/objectivec/index.html b/docs/api/objectivec/index.html similarity index 100% rename from objectivec/index.html rename to docs/api/objectivec/index.html diff --git a/objectivec/js/jazzy.js b/docs/api/objectivec/js/jazzy.js similarity index 100% rename from objectivec/js/jazzy.js rename to docs/api/objectivec/js/jazzy.js diff --git a/objectivec/js/jazzy.search.js b/docs/api/objectivec/js/jazzy.search.js similarity index 100% rename from objectivec/js/jazzy.search.js rename to docs/api/objectivec/js/jazzy.search.js diff --git a/objectivec/js/jquery.min.js b/docs/api/objectivec/js/jquery.min.js similarity index 100% rename from objectivec/js/jquery.min.js rename to docs/api/objectivec/js/jquery.min.js diff --git a/objectivec/js/lunr.min.js b/docs/api/objectivec/js/lunr.min.js similarity index 100% rename from objectivec/js/lunr.min.js rename to docs/api/objectivec/js/lunr.min.js diff --git a/objectivec/js/typeahead.jquery.js b/docs/api/objectivec/js/typeahead.jquery.js similarity index 100% rename from objectivec/js/typeahead.jquery.js rename to docs/api/objectivec/js/typeahead.jquery.js diff --git a/objectivec/search.json b/docs/api/objectivec/search.json similarity index 100% rename from objectivec/search.json rename to docs/api/objectivec/search.json diff --git a/docs/reference/api/other-apis.md b/docs/api/other-apis.md similarity index 75% rename from docs/reference/api/other-apis.md rename to docs/api/other-apis.md index 5ff536e36e..4868d6ca0c 100644 --- a/docs/reference/api/other-apis.md +++ b/docs/api/other-apis.md @@ -1,8 +1,7 @@ --- title: Other Inference APIs -parent: API docs -grand_parent: Reference -nav_order: 9 +parent: API Docs +nav_order: 6 --- # Other APIs @@ -23,8 +22,8 @@ This is an community-contributed project and not officially supported by the cor ### API Reference {: .no_toc } -[https://github.com/ankane/onnxruntime](https://github.com/ankane/onnxruntime) +[https://github.com/ankane/onnxruntime](https://github.com/ankane/onnxruntime){:target="_blank"} ### Samples {: .no_toc } -[Ruby Samples](https://ankane.org/tensorflow-ruby) \ No newline at end of file +[Ruby Samples](https://ankane.org/tensorflow-ruby){:target="_blank"} \ No newline at end of file diff --git a/docs/api/python-api.md b/docs/api/python-api.md new file mode 100644 index 0000000000..9b822ea424 --- /dev/null +++ b/docs/api/python-api.md @@ -0,0 +1,11 @@ +--- +title: Python API +parent: API Docs +nav_order: 1 +--- + +# ORT Python API +{: .no_toc } + + + [Go to the ORT Python API Docs](./python/api_summary.html){: .btn .mr-4 target="_blank"} \ No newline at end of file diff --git a/python/.buildinfo b/docs/api/python/.buildinfo similarity index 100% rename from python/.buildinfo rename to docs/api/python/.buildinfo diff --git a/python/.nojekyll b/docs/api/python/.nojekyll similarity index 100% rename from python/.nojekyll rename to docs/api/python/.nojekyll diff --git a/python/README.html b/docs/api/python/README.html similarity index 100% rename from python/README.html rename to docs/api/python/README.html diff --git a/python/api_summary.html b/docs/api/python/api_summary.html similarity index 97% rename from python/api_summary.html rename to docs/api/python/api_summary.html index cb62bde81e..f3f890d359 100644 --- a/python/api_summary.html +++ b/docs/api/python/api_summary.html @@ -522,58 +522,7 @@ In particular it’s used in the testing suite.

    - -
    -