Skip to content

Commit

Permalink
Update Python API docs to commit 05ebdcb (#19)
Browse files Browse the repository at this point in the history
Co-authored-by: natke <natke@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and natke authored Feb 16, 2022
1 parent 30769bf commit f4bf578
Show file tree
Hide file tree
Showing 39 changed files with 408 additions and 488 deletions.
196 changes: 106 additions & 90 deletions docs/api/python/api_summary.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/api/python/auto_examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Draw a pipeline" href="plot_pipeline.html" />
<link rel="prev" title="API Summary" href="../api_summary.html" />
<link rel="prev" title="API" href="../api_summary.html" />

<link rel="stylesheet" href="../static/custom.css" type="text/css" />

Expand Down Expand Up @@ -139,15 +139,15 @@ <h1 class="logo"><a href="../index.html">ONNX Runtime</a></h1>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Gallery of examples</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li>Previous: <a href="../api_summary.html" title="previous chapter">API Summary</a></li>
<li>Previous: <a href="../api_summary.html" title="previous chapter">API</a></li>
<li>Next: <a href="plot_pipeline.html" title="next chapter">Draw a pipeline</a></li>
</ul></li>
</ul>
Expand Down Expand Up @@ -178,7 +178,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, Microsoft.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
6 changes: 3 additions & 3 deletions docs/api/python/auto_examples/plot_backend.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
<p>The backend API is implemented by other frameworks
and makes it easier to switch between multiple runtimes
with the same API.</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.014 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.017 seconds)</p>
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-backend-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<p><a class="reference download internal" download="" href="../downloads/3e23fa9ebb26f4728ee8426ed7da0f63/plot_backend.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_backend.py</span></code></a></p>
Expand Down Expand Up @@ -136,7 +136,7 @@ <h1 class="logo"><a href="../index.html">ONNX Runtime</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Gallery of examples</a></li>
</ul>

Expand Down Expand Up @@ -177,7 +177,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, Microsoft.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
6 changes: 3 additions & 3 deletions docs/api/python/auto_examples/plot_common_errors.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@
ERROR with Shape=(2, 1, 2) - [ONNXRuntimeError] : 2 : INVALID_ARGUMENT : Invalid rank for input: float_input Got: 3 Expected: 2 Please fix either the inputs or the model.
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.009 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.010 seconds)</p>
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-common-errors-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<p><a class="reference download internal" download="" href="../downloads/3a2955e44bf8f95a0eee6e71695ad788/plot_common_errors.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_common_errors.py</span></code></a></p>
Expand Down Expand Up @@ -237,7 +237,7 @@ <h1 class="logo"><a href="../index.html">ONNX Runtime</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Gallery of examples</a></li>
</ul>

Expand Down Expand Up @@ -278,7 +278,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, Microsoft.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ <h2><a class="toc-backref" href="#id1">Train a pipeline</a><a class="headerlink"
</pre></div>
</div>
<p class="sphx-glr-script-out">Out:</p>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>0.9209977605173356
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>0.915704460659449
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -193,12 +193,12 @@ <h2><a class="toc-backref" href="#id2">Conversion to ONNX format</a><a class="he
</pre></div>
</div>
<p class="sphx-glr-script-out">Out:</p>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>0.9999999999999366
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>0.9999999999999281
</pre></div>
</div>
<p>Very similar. <em>ONNX Runtime</em> uses floats instead of doubles,
that explains the small discrepencies.</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.966 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 1.141 seconds)</p>
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-convert-pipeline-vectorizer-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<p><a class="reference download internal" download="" href="../downloads/982a1f7abbb8ffc5d5e98b671c35e5aa/plot_convert_pipeline_vectorizer.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_convert_pipeline_vectorizer.py</span></code></a></p>
Expand Down Expand Up @@ -233,7 +233,7 @@ <h1 class="logo"><a href="../index.html">ONNX Runtime</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Gallery of examples</a></li>
</ul>

Expand Down Expand Up @@ -274,7 +274,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, Microsoft.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
32 changes: 16 additions & 16 deletions docs/api/python/auto_examples/plot_load_and_predict.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,20 +98,20 @@
</pre></div>
</div>
<p class="sphx-glr-script-out">Out:</p>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[array([[[0.6423601 , 0.65232253, 0.6620137 , 0.708999 , 0.65169865],
[0.548968 , 0.59544575, 0.7161434 , 0.525905 , 0.7210646 ],
[0.5178277 , 0.5842683 , 0.5627599 , 0.6324704 , 0.5833795 ],
[0.69634616, 0.60848683, 0.6746977 , 0.50677085, 0.5549751 ]],

[[0.5097179 , 0.59407187, 0.56360227, 0.7223234 , 0.5392329 ],
[0.5398089 , 0.5622808 , 0.5369593 , 0.5819309 , 0.5735331 ],
[0.5688669 , 0.71247685, 0.63964766, 0.63349843, 0.63380575],
[0.64378905, 0.60552883, 0.5184905 , 0.6312441 , 0.5047166 ]],

[[0.63900065, 0.6108959 , 0.5249817 , 0.5055595 , 0.55390376],
[0.62443805, 0.550723 , 0.5320551 , 0.5522731 , 0.68858314],
[0.69650024, 0.54673976, 0.56964463, 0.58536506, 0.5743989 ],
[0.6382853 , 0.5826889 , 0.53635114, 0.52279866, 0.7300966 ]]],
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[array([[[0.6613654 , 0.7164093 , 0.5314087 , 0.7067613 , 0.70412177],
[0.7080177 , 0.54169816, 0.6488505 , 0.5935635 , 0.7268913 ],
[0.57318795, 0.50276023, 0.62565476, 0.6204073 , 0.65596694],
[0.59989387, 0.59642035, 0.72549963, 0.70181483, 0.603905 ]],

[[0.70841444, 0.6787628 , 0.6373904 , 0.6612957 , 0.66548526],
[0.5030165 , 0.50026876, 0.6943428 , 0.7046919 , 0.65267944],
[0.5492975 , 0.70328647, 0.70220387, 0.64173555, 0.71524936],
[0.63749886, 0.61553544, 0.5967878 , 0.7181717 , 0.6559915 ]],

[[0.5325055 , 0.57738787, 0.58325106, 0.7022748 , 0.541571 ],
[0.662003 , 0.5770094 , 0.7068774 , 0.56496465, 0.62275225],
[0.69648486, 0.6892656 , 0.71441233, 0.69432604, 0.5038529 ],
[0.703531 , 0.7261627 , 0.59789884, 0.67254007, 0.5533266 ]]],
dtype=float32)]
</pre></div>
</div>
Expand Down Expand Up @@ -149,7 +149,7 @@ <h1 class="logo"><a href="../index.html">ONNX Runtime</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Gallery of examples</a></li>
</ul>

Expand Down Expand Up @@ -190,7 +190,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, Microsoft.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
4 changes: 2 additions & 2 deletions docs/api/python/auto_examples/plot_metadata.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h1 class="logo"><a href="../index.html">ONNX Runtime</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Gallery of examples</a></li>
</ul>

Expand Down Expand Up @@ -174,7 +174,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, Microsoft.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
8 changes: 4 additions & 4 deletions docs/api/python/auto_examples/plot_pipeline.html
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,10 @@ <h2><a class="toc-backref" href="#id2">Draw a model with ONNX</a><a class="heade
</pre></div>
</div>
<img src="../images/sphx_glr_plot_pipeline_001.png" srcset="../images/sphx_glr_plot_pipeline_001.png" alt="plot pipeline" class = "sphx-glr-single-img"/><p class="sphx-glr-script-out">Out:</p>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.image.AxesImage object at 0x7feafe274ac0&gt;
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>&lt;matplotlib.image.AxesImage object at 0x7fa9ca3043d0&gt;
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.196 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.296 seconds)</p>
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-pipeline-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<p><a class="reference download internal" download="" href="../downloads/d436e9922b51a71358604ec00f09e7e4/plot_pipeline.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_pipeline.py</span></code></a></p>
Expand Down Expand Up @@ -206,7 +206,7 @@ <h1 class="logo"><a href="../index.html">ONNX Runtime</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Gallery of examples</a></li>
</ul>

Expand Down Expand Up @@ -247,7 +247,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, Microsoft.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
24 changes: 12 additions & 12 deletions docs/api/python/auto_examples/plot_profiling.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
</pre></div>
</div>
<p class="sphx-glr-script-out">Out:</p>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>onnxruntime_profile__2022-01-04_17-09-55.json
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>onnxruntime_profile__2022-02-16_20-16-28.json
</pre></div>
</div>
<p>The results are stored un a file in JSON format.
Expand All @@ -111,23 +111,23 @@
<p class="sphx-glr-script-out">Out:</p>
<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[{&#39;args&#39;: {},
&#39;cat&#39;: &#39;Session&#39;,
&#39;dur&#39;: 56,
&#39;dur&#39;: 95,
&#39;name&#39;: &#39;model_loading_array&#39;,
&#39;ph&#39;: &#39;X&#39;,
&#39;pid&#39;: 3089,
&#39;tid&#39;: 3089,
&#39;ts&#39;: 1},
&#39;pid&#39;: 2881,
&#39;tid&#39;: 2881,
&#39;ts&#39;: 2},
{&#39;args&#39;: {},
&#39;cat&#39;: &#39;Session&#39;,
&#39;dur&#39;: 240,
&#39;dur&#39;: 275,
&#39;name&#39;: &#39;session_initialization&#39;,
&#39;ph&#39;: &#39;X&#39;,
&#39;pid&#39;: 3089,
&#39;tid&#39;: 3089,
&#39;ts&#39;: 71}]
&#39;pid&#39;: 2881,
&#39;tid&#39;: 2881,
&#39;ts&#39;: 116}]
</pre></div>
</div>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.007 seconds)</p>
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.006 seconds)</p>
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-profiling-py">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<p><a class="reference download internal" download="" href="../downloads/cfe61aca1f0a89486c7024466ea500fd/plot_profiling.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">plot_profiling.py</span></code></a></p>
Expand Down Expand Up @@ -161,7 +161,7 @@ <h1 class="logo"><a href="../index.html">ONNX Runtime</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Gallery of examples</a></li>
</ul>

Expand Down Expand Up @@ -202,7 +202,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2018-2021, Microsoft.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.4.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
Loading

0 comments on commit f4bf578

Please sign in to comment.