Skip to content

Commit

Permalink
[Docs] Update mobile docs for 1.9 (microsoft#9237)
Browse files Browse the repository at this point in the history 
* Edgchen1/objc api reference 1.9 (#1)

* Update Objective-C API reference for 1.9.

* Update spelling.

* Test link changes.

* Fix links.

* Fix links and updates in mobile-performance-tuning.md.

* Fix links in tutorials/mobile/custom-build.md.

* Fix

* Fix

* Fix links in docs/tutorials/mobile/initial-setup.md.

* Fix links.

* Update note.

* Add 1.9 op type support page.

* Add nav info to page.

* Rename files to not have spaces.
  • Loading branch information
@edgchen1
edgchen1 authored Oct 4, 2021
1 parent 9fa90d7 commit 3c9ca35
Show file tree
Hide file tree
Showing 57 changed files with 717 additions and 551 deletions.
2 changes: 1 addition & 1 deletion docs/api/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ nav_order: 5
|:----------------------------------------------------------------------------------|
| <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"> [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"> [JavaScript API Docs](./js/index.html){: .btn} </span>|
Expand Down
6 changes: 3 additions & 3 deletions docs/api/objectivec/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -371,8 +371,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/objectivec/Classes/ORTCoreMLExecutionProviderOptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ORTCoreMLExecutionProviderOptions Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="../index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -216,8 +216,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/objectivec/Classes/ORTEnv.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ORTEnv Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="../index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -218,8 +218,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/objectivec/Classes/ORTRunOptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ORTRunOptions Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="../index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -424,8 +424,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/objectivec/Classes/ORTSession.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ORTSession Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="../index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -604,8 +604,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/objectivec/Classes/ORTSessionOptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ORTSessionOptions Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="../index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -715,8 +715,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/objectivec/Classes/ORTTensorTypeAndShapeInfo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ORTTensorTypeAndShapeInfo Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="../index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -183,8 +183,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/objectivec/Classes/ORTValue.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ORTValue Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="../index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -420,8 +420,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/objectivec/Classes/ORTValueTypeInfo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="ORTValueTypeInfo Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="../index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -183,8 +183,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
14 changes: 7 additions & 7 deletions docs/api/objectivec/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">ONNX Runtime Objective-C API 1.8.1 Docs</a></p>
<p><a href="index.html">ONNX Runtime Objective-C API 1.9.0 Docs</a></p>
<p class="header-right"><a href="https://github.com/microsoft/onnxruntime"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -123,7 +123,7 @@ <h1>Enumerations</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">ORTLoggingLevel</span> <span class="o">:</span> <span class="kt">int32_t</span> <span class="p">{}</span></code></pre>
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">ORTLoggingLevel</span> <span class="p">{}</span></code></pre>

</div>
<div class="language">
Expand Down Expand Up @@ -157,7 +157,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">ORTValueType</span> <span class="o">:</span> <span class="kt">int32_t</span> <span class="p">{}</span></code></pre>
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">ORTValueType</span> <span class="p">{}</span></code></pre>

</div>
<div class="language">
Expand Down Expand Up @@ -191,7 +191,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">ORTTensorElementDataType</span> <span class="o">:</span> <span class="kt">int32_t</span> <span class="p">{}</span></code></pre>
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">ORTTensorElementDataType</span> <span class="p">{}</span></code></pre>

</div>
<div class="language">
Expand Down Expand Up @@ -226,7 +226,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">ORTGraphOptimizationLevel</span> <span class="o">:</span> <span class="kt">int32_t</span> <span class="p">{}</span></code></pre>
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">ORTGraphOptimizationLevel</span> <span class="p">{}</span></code></pre>

</div>
<div class="language">
Expand All @@ -243,8 +243,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-07-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.7</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2021 <a class="link" href="https://www.onnxruntime.ai" target="_blank" rel="noopener" rel="external">ONNX Runtime Authors</a>. All rights reserved. (Last updated: 2021-09-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit 3c9ca35

Please sign in to comment.