From c878b7e988c25bc81171bbad4fa6055c84ff2582 Mon Sep 17 00:00:00 2001 From: Faith Xu Date: Tue, 5 Oct 2021 11:50:38 -0700 Subject: [PATCH] [Docs] Fix links and formatting (#9253) * fix links and format issues * fix sidebar ordering --- docs/get-started/training-pytorch.md | 9 +-- docs/get-started/with-csharp.md | 2 +- docs/get-started/with-iot.md | 2 +- docs/get-started/with-java.md | 2 +- docs/get-started/with-javascript.md | 2 +- docs/get-started/with-mobile.md | 2 +- docs/get-started/with-winrt.md | 2 +- docs/tutorials/accelerate-pytorch/index.md | 2 +- docs/tutorials/mobile.md | 10 --- docs/tutorials/mobile/index.md | 2 +- js/script.js | 88 ++++++++++------------ 11 files changed, 51 insertions(+), 72 deletions(-) delete mode 100644 docs/tutorials/mobile.md diff --git a/docs/get-started/training-pytorch.md b/docs/get-started/training-pytorch.md index 56d73cdb08..0aafeed490 100644 --- a/docs/get-started/training-pytorch.md +++ b/docs/get-started/training-pytorch.md @@ -1,7 +1,7 @@ --- title: ORT Training with PyTorch parent: Get Started -nav_order: 10 +nav_order: 9 --- # Get started with ORT for Training API (PyTorch) @@ -28,11 +28,6 @@ python -m torch_ort.configure model = ORTModule(model) ``` -## Contents -{: .no_toc } - -* TOC placeholder -{:toc} ## Samples -[ONNX Runtime Training Examples](../tutorials/training) \ No newline at end of file +[ONNX Runtime Training Examples](https://github.com/microsoft/onnxruntime-training-examples) \ No newline at end of file diff --git a/docs/get-started/with-csharp.md b/docs/get-started/with-csharp.md index 008d2038ac..256f23ca8b 100644 --- a/docs/get-started/with-csharp.md +++ b/docs/get-started/with-csharp.md @@ -2,7 +2,7 @@ title: C# parent: Get Started toc: true -nav_order: 2 +nav_order: 3 --- # Get started with ORT for C# {: .no_toc } diff --git a/docs/get-started/with-iot.md b/docs/get-started/with-iot.md index 943d04863d..530c112442 100644 --- a/docs/get-started/with-iot.md +++ b/docs/get-started/with-iot.md @@ -2,7 +2,7 @@ title: IoT and Edge parent: Get Started toc: true -nav_order: 8 +nav_order: 7 --- # Get Started with ORT for IoT {: .no_toc } diff --git a/docs/get-started/with-java.md b/docs/get-started/with-java.md index acdaa521ea..0d7877c4c3 100644 --- a/docs/get-started/with-java.md +++ b/docs/get-started/with-java.md @@ -2,7 +2,7 @@ title: Java parent: Get Started toc: true -nav_order: 4 +nav_order: 5 --- # Get Started with ORT for Java {: .no_toc } diff --git a/docs/get-started/with-javascript.md b/docs/get-started/with-javascript.md index 0ed8b30090..e1a87f689c 100644 --- a/docs/get-started/with-javascript.md +++ b/docs/get-started/with-javascript.md @@ -2,7 +2,7 @@ title: JavaScript parent: Get Started toc: true -nav_order: 3 +nav_order: 4 --- # Get started with ORT for JavaScript diff --git a/docs/get-started/with-mobile.md b/docs/get-started/with-mobile.md index ddc1af21e5..8c8ef4e1e4 100644 --- a/docs/get-started/with-mobile.md +++ b/docs/get-started/with-mobile.md @@ -2,7 +2,7 @@ title: Mobile parent: Get Started toc: true -nav_order: 7 +nav_order: 6 --- # Get Started with ORT for Mobile {: .no_toc } diff --git a/docs/get-started/with-winrt.md b/docs/get-started/with-winrt.md index 67651a44ac..b2d92789e2 100644 --- a/docs/get-started/with-winrt.md +++ b/docs/get-started/with-winrt.md @@ -2,7 +2,7 @@ title: WinRT parent: Get Started toc: true -nav_order: 10 +nav_order: 8 --- diff --git a/docs/tutorials/accelerate-pytorch/index.md b/docs/tutorials/accelerate-pytorch/index.md index b7f49211e4..3fc1591f1f 100644 --- a/docs/tutorials/accelerate-pytorch/index.md +++ b/docs/tutorials/accelerate-pytorch/index.md @@ -1,7 +1,7 @@ --- title: Accelerate PyTorch has_children: true -nav_order: 3 +nav_order: 2 parent: Tutorials --- diff --git a/docs/tutorials/mobile.md b/docs/tutorials/mobile.md deleted file mode 100644 index 57beb8ebd4..0000000000 --- a/docs/tutorials/mobile.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Deploy on mobile -parent: Tutorials -nav_order: 5 ---- -# Deploy ML models on mobile devices -ONNX Runtime can be used to performantly deploy models on mobile devices. Learn more [here](./mobile/overview.md). - -* *[COMING SOON]* Deploy ORT on Android -* *[COMING SOON]* Deploy ORT on iOS diff --git a/docs/tutorials/mobile/index.md b/docs/tutorials/mobile/index.md index e2936596e8..32150cd15e 100644 --- a/docs/tutorials/mobile/index.md +++ b/docs/tutorials/mobile/index.md @@ -2,7 +2,7 @@ title: Deploy ONNX Runtime Mobile parent: Tutorials has_children: true -nav_order: 4 +nav_order: 5 --- # How To: Deploy ONNX Runtime on Mobile/Edge devices diff --git a/js/script.js b/js/script.js index 389c15f379..be6bb659d5 100644 --- a/js/script.js +++ b/js/script.js @@ -551,7 +551,7 @@ var ot_validCombos = { "This combination requires an AMD docker image. See the torch-ort repo for details", "ot_linux,ot_PyTorch18,ot_X64,ot_DNNL": - "This combination of resources is not fully tested. It may be possible to build from source.", + "This combination of resources is not fully tested. It may be possible to build from source.", "ot_linux,ot_PyTorch19,ot_X64,ot_CUDA10": "pip install torch-ort
python -m torch_ort.configure", @@ -566,30 +566,30 @@ var ot_validCombos = { "This combination requires an AMD docker image. See the torch-ort repo for details", "ot_linux,ot_C++,ot_X64,ot_CUDA10": - "This combination of resources is not fully tested. It may be possible to build from source.", + "This combination of resources is not fully tested. It may be possible to build from source.", "ot_linux,ot_C++,ot_X64,ot_DefaultCPU": - "This combination of resources is not fully tested. It may be possible to build from source.", + "This combination of resources is not fully tested. It may be possible to build from source.", //windows "ot_windows,ot_PyTorch18,ot_X64,ot_CUDA10": - "This combination of resources is not fully tested. It may be possible to build from source.", + "This combination of resources is not fully tested. It may be possible to build from source.", "ot_windows,ot_PyTorch18,ot_X64,ot_DefaultCPU": - "This combination of resources is not fully tested. It may be possible to build from source.", + "This combination of resources is not fully tested. It may be possible to build from source.", "ot_windows,ot_C++,ot_X64,ot_DefaultCPU": - "This combination of resources is not fully tested. It may be possible to build from source.", + "This combination of resources is not fully tested. It may be possible to build from source.", "ot_windows,ot_C++,ot_X64,ot_CUDA10": - "This combination of resources is not fully tested. It may be possible to build from source.", + "This combination of resources is not fully tested. It may be possible to build from source.", //mac "ot_mac,ot_PyTorch18,ot_X64,ot_DefaultCPU": - "This combination of resources is not fully tested. It may be possible to build from source.", + "This combination of resources is not fully tested. It may be possible to build from source.", "ot_mac,ot_C++,ot_X64,ot_DefaultCPU": - "This combination of resources is not fully tested. It may be possible to build from source." + "This combination of resources is not fully tested. It may be possible to build from source." }; function ot_commandMessage(key) { @@ -635,31 +635,31 @@ function ot_commandMessage(key) { var validCombos = { "windows,C-API,X64,CUDA": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", "windows,C++,X64,CUDA": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", "windows,C#,X64,CUDA": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", "windows,Python,X64,CUDA": - "pip install onnxruntime-gpu
Refer to docs for requirements.", + "pip install onnxruntime-gpu
Refer to docs for requirements.", "linux,Python,ARM64,CUDA": "For Jetpack 4.4+, follow installation instructions from here", "linux,C-API,X64,CUDA": - "Download .tgz file from Github
Refer to docs for requirements.", + "Download .tgz file from Github
Refer to docs for requirements.", "linux,C++,X64,CUDA": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", "linux,C#,X64,CUDA": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for requirements.", "linux,Python,X64,CUDA": - "pip install onnxruntime-gpu
Refer to docs for requirements.", + "pip install onnxruntime-gpu
Refer to docs for requirements.", "linux,C-API,ARM32,DefaultCPU": "Follow build instructions from here", @@ -809,55 +809,55 @@ var validCombos = { "Follow build instructions from here", "windows,C-API,X64,TensorRT": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", "windows,C++,X64,TensorRT": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", "windows,C#,X64,TensorRT": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", "windows,Python,X64,TensorRT": "Follow build instructions from here", "linux,C-API,X64,TensorRT": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", "linux,C++,X64,TensorRT": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", "linux,C#,X64,TensorRT": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", "linux,Python,X64,TensorRT": "Follow build instructions from here", "linux,C-API,ARM64,TensorRT": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", "linux,C++,ARM64,TensorRT": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", "linux,C#,ARM64,TensorRT": - "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", + "Install Nuget package Microsoft.ML.OnnxRuntime.Gpu
Refer to docs for usage details.", "linux,Python,ARM64,TensorRT": "Follow build instructions from here", "mac,C-API,X86,DefaultCPU": - "This combination of resources has not yet been tested. It may be possible to build from source.", + "This combination of resources has not yet been tested. It may be possible to build from source.", "mac,C++,X86,DefaultCPU": - "This combination of resources has not yet been tested. It may be possible to build from source.", + "This combination of resources has not yet been tested. It may be possible to build from source.", "mac,C#,X86,DefaultCPU": - "This combination of resources has not yet been tested. It may be possible to build from source.", + "This combination of resources has not yet been tested. It may be possible to build from source.", "mac,Python,X86,DefaultCPU": - "This combination of resources has not yet been tested. It may be possible to build from source.", + "This combination of resources has not yet been tested. It may be possible to build from source.", "windows,C-API,X86,DirectML": - "Install Nuget package Microsoft.ML.OnnxRuntime.DirectML
Refer to docs for requirements.", + "Install Nuget package Microsoft.ML.OnnxRuntime.DirectML
Refer to docs for requirements.", "windows,C++,X86,DirectML": "Install Nuget package Microsoft.ML.OnnxRuntime.DirectML", @@ -896,7 +896,7 @@ var validCombos = { "Add a dependency on com.microsoft.onnxruntime:onnxruntime using Maven/Gradle", "linux,Java,X64,CUDA": - "Add a dependency on com.microsoft.onnxruntime:onnxruntime_gpu using Maven/Gradle.
Refer to docs for requirements.", + "Add a dependency on com.microsoft.onnxruntime:onnxruntime_gpu using Maven/Gradle.
Refer to docs for requirements.", "mac,Java,X64,DefaultCPU": "Add a dependency on com.microsoft.onnxruntime:onnxruntime using Maven/Gradle", @@ -951,37 +951,31 @@ var validCombos = { "Add a dependency on com.microsoft.onnxruntime:onnxruntime using Maven/Gradle", "windows,Java,X64,CUDA": - "Add a dependency on com.microsoft.onnxruntime:onnxruntime_gpu using Maven/Gradle.
Refer to docs for requirements.", + "Add a dependency on com.microsoft.onnxruntime:onnxruntime_gpu using Maven/Gradle.
Refer to docs for requirements.", "windows,Java,X64,TensorRT": - "Add a dependency on com.microsoft.onnxruntime:onnxruntime_gpu using Maven/Gradle.
Refer to docs for usage details.", + "Add a dependency on com.microsoft.onnxruntime:onnxruntime_gpu using Maven/Gradle.
Refer to docs for usage details.", "windows,Java,X64,DNNL": - "Follow build and API instructions", - - "windows,Java,X64,nGraph": - "Follow build and API instructions", + "Follow build and API instructions", "windows,Java,X64,NUPHAR": - "Follow build and API instructions", + "Follow build and API instructions", "windows,Java,X64,OpenVINO": - "Follow build and API instructions", + "Follow build and API instructions", "linux,Java,X64,TensorRT": - "Add a dependency on com.microsoft.onnxruntime:onnxruntime_gpu using Maven/Gradle.
Refer to docs for usage details.", + "Add a dependency on com.microsoft.onnxruntime:onnxruntime_gpu using Maven/Gradle.
Refer to docs for usage details.", "linux,Java,X64,DNNL": - "Follow build and API instructions", - - "linux,Java,X64,nGraph": - "Follow build and API instructions", + "Follow build and API instructions", "linux,Java,X64,NUPHAR": - "Follow build and API instructions", + "Follow build and API instructions", "linux,Java,X64,OpenVINO": - "Follow build and API instructions", + "Follow build and API instructions", "android,C-API,ARM64,NNAPI": "Follow build instructions from here",