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
This commit is contained in:
Cassie 2021-09-15 16:23:42 -05:00 committed by GitHub
parent 80267ba99a
commit a0f3e30de6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
331 changed files with 989 additions and 519 deletions

1
.gitignore vendored
View file

@ -2,6 +2,7 @@ _site
.sass-cache
.jekyll-metadata
*.out
.venv
# direnv, posh-direnv
.envrc

View file

@ -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

View file

@ -88,7 +88,7 @@
<div class="col-12 col-md-6 pr-10">
<h2>Optimization and acceleration</h2>
<p>
Run any ONNX model using a single set of inference <a href="https://www.onnxruntime.ai/docs/reference/api/" target="_blank" class="link"><abbr title="Application Program Interface">API</abbr>s</a> that provide access to the best hardware acceleration available. Built-in optimization features trim and consolidate nodes without impacting model accuracy. Additionally, full backwards <a href="https://www.onnxruntime.ai/docs/resources/compatibility.html" target="_blank" class="link">compatibility</a> for ONNX and ONNX-<abbr>ML</abbr> ensures all ONNX models can be inferenced.
Run any ONNX model using a single set of inference <a href="https://www.onnxruntime.ai/docs/api/" target="_blank" class="link"><abbr title="Application Program Interface">API</abbr>s</a> that provide access to the best hardware acceleration available. Built-in optimization features trim and consolidate nodes without impacting model accuracy. Additionally, full backwards <a href="https://www.onnxruntime.ai/docs/resources/compatibility.html" target="_blank" class="link">compatibility</a> for ONNX and ONNX-<abbr>ML</abbr> ensures all ONNX models can be inferenced.
</p>
</div>
</div>
@ -99,7 +99,7 @@
<div class="col-12 col-md-6 order-md-1 pr-10">
<h2><abbr title="Application Program Interface">API</abbr> and platform support</h2>
<p>
Take advantage of the benefits of ONNX Runtime without changing your technology stack. Access ONNX Runtime using your preferred <a href="https://www.onnxruntime.ai/docs/reference/api/" target="_blank" class="link"><abbr title="Application Program Interface">API</abbr></a> &mdash; <abbr>C#</abbr>, <abbr>C++</abbr>, 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 <a href="https://www.onnxruntime.ai/docs/api/" target="_blank" class="link"><abbr title="Application Program Interface">API</abbr></a> &mdash; <abbr>C#</abbr>, <abbr>C++</abbr>, C, Python, or Java. Support for Linux, Windows and Mac allows you to build and deploy applications without worry.
</p>
</div>
</div>
@ -173,7 +173,7 @@
<span class="link-content">Tutorials</span><span class="link-arrow fa fa-angle-right"></span></a>
</li>
<li class="mb-2">
<a target="_blank" href="https://www.onnxruntime.ai/docs/reference/api/">
<a target="_blank" href="https://www.onnxruntime.ai/docs/api/">
<span class="link-content"><abbr title="Application Program Interface">APIs</abbr></span><span class="link-arrow fa fa-angle-right"></span></a>
</li>
</ul>

View file

@ -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.

15
docs/api/index.md Normal file
View file

@ -0,0 +1,15 @@
---
title: API Docs
has_children: true
nav_order: 5
---
# ORT API docs
{: .no_toc }
|:----------------------------------------------------------------------------------|
| <span class="fs-5"> [Python API Docs](./python/api_summary.html){: .btn } </span> |
| <span class="fs-5"> [Java API Docs](./java/index.html){: .btn} </span> |
| <span class="fs-5"> [Objective C Docs](./objectivec/index.html){: .btn} </span> |
| <span class="fs-5"> [WinRT API Docs](https://docs.microsoft.com/windows/ai/windows-ml/api-reference){: .btn} </span>|
| <span class="fs-5"> [C# API Docs](./csharp-api){: .btn} </span>|
| <span class="fs-5"> [Other API Docs](./other-apis){: .btn} </span>|

10
docs/api/java-api.md Normal file
View file

@ -0,0 +1,10 @@
---
title: Java API
parent: API Docs
nav_order: 3
---
# ORT Java Docs
{: .no_toc }
<span class="fs-5"> [Go to the Java Docs](./java/index.html){: .btn .mr-4 target="_blank"} </span>

View file

@ -3,7 +3,7 @@
Overall document style
*/
@import url('resources/fonts/dejavu.css');
@import url('../../../resources/fonts/dejavu.css');
body {
background-color:#ffffff;

View file

@ -0,0 +1,10 @@
---
title: Objective-C API
parent: API Docs
nav_order: 4
---
# ORT Objective-C Docs
{: .no_toc }
<span class="fs-5"> [Go to the Objective-C Docs](./objectivec/index.html){: .btn .mr-4 target="_blank"} </span>

Some files were not shown because too many files have changed in this diff Show more