Skip to content

[Docs] Update mobile docs for 1.9 #9237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Faith Xu (faxu) merged 14 commits into from
Oct 4, 2021
Merged

[Docs] Update mobile docs for 1.9 #9237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
1eaf833
Edgchen1/objc api reference 1.9 (#1)
edgchen1 Sep 25, 2021
8d0f486
Test link changes.
edgchen1 Sep 30, 2021
138ed2a
Fix links.
edgchen1 Sep 30, 2021
50e6b15
Fix links and updates in mobile-performance-tuning.md.
edgchen1 Sep 30, 2021
5e9f580
Fix links in tutorials/mobile/custom-build.md.
edgchen1 Sep 30, 2021
0154133
Fix
edgchen1 Sep 30, 2021
f2bbcf0
Fix
edgchen1 Sep 30, 2021
e53d7d5
Fix links in docs/tutorials/mobile/initial-setup.md.
edgchen1 Sep 30, 2021
8b706bf
Fix links.
edgchen1 Sep 30, 2021
10c2107
Update note.
edgchen1 Sep 30, 2021
0a7264f
Add 1.9 op type support page.
edgchen1 Oct 1, 2021
5f0705e
Add nav info to page.
edgchen1 Oct 1, 2021
feae33a
Merge branch 'edgchen1/objc_api_reference_1.9' into edgchen1/mobile_docs
edgchen1 Oct 1, 2021
29de22a
Rename files to not have spaces.
edgchen1 Oct 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/index.md
View file
Open in desktop
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> |
Comment thread
faxu marked this conversation as resolved.
| <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
Open in desktop
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
Open in desktop
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
Open in desktop
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
Open in desktop
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
Open in desktop
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
Open in desktop
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
Open in desktop
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
Open in desktop
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
Open in desktop
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
Open in desktop
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