Skip to content

[Automated]: Update Python API docs #2

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

Open
github-actions wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

[Automated]: Update Python API docs #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/python/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 36e772eb12f6d489cf39825d3e063ad4
config: 8e1f5fa515073dcc8e8815ff920f1477
tags: 645f666f9bcd5a90fca523b33c5a78b7
308 changes: 193 additions & 115 deletions docs/api/python/api_summary.html
View file
Open in desktop

Large diffs are not rendered by default.

105 changes: 34 additions & 71 deletions docs/api/python/auto_examples/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>Gallery of examples &#8212; ONNX Runtime 1.11.0 documentation</title>
<title>Gallery of examples &#8212; ONNX Runtime 1.13.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../static/alabaster.css" />
<link rel="stylesheet" type="text/css" href="../static/graphviz.css" />
Expand All @@ -17,11 +17,12 @@
<script data-url_root="../" id="documentation_options" src="../static/documentation_options.js"></script>
<script src="../static/jquery.js"></script>
<script src="../static/underscore.js"></script>
<script src="../static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../static/doctools.js"></script>
<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 All @@ -39,74 +40,36 @@
<div class="body" role="main">

<section id="gallery-of-examples">
<span id="sphx-glr-auto-examples"></span><h1>Gallery of examples<a class="headerlink" href="#gallery-of-examples" title="Permalink to this headline">¶</a></h1>
<h1>Gallery of examples<a class="headerlink" href="#gallery-of-examples" title="Permalink to this heading">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<div class="sphx-glr-thumbcontainer" tooltip="There is no other way to look into one model stored in ONNX format than looking into its node w..."><figure class="align-default" id="id1">
<img alt="Draw a pipeline" src="../images/sphx_glr_plot_pipeline_thumb.png" />
<figcaption>
<p><span class="caption-text"><a class="reference internal" href="plot_pipeline.html#sphx-glr-auto-examples-plot-pipeline-py"><span class="std std-ref">Draw a pipeline</span></a></span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
</figcaption>
</figure>
</div><div class="toctree-wrapper compound">
<div class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="There is no other way to look into one model stored in ONNX format than looking into its node w..."><img alt="Draw a pipeline" src="../images/sphx_glr_plot_pipeline_thumb.png" />
<p><a class="reference internal" href="plot_pipeline.html#sphx-glr-auto-examples-plot-pipeline-py"><span class="std std-ref">Draw a pipeline</span></a></p>
<div class="sphx-glr-thumbnail-title">Draw a pipeline</div>
</div><div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to load a model and compute the output for an input vector. It al..."><img alt="Load and predict with ONNX Runtime and a very simple model" src="../images/sphx_glr_plot_load_and_predict_thumb.png" />
<p><a class="reference internal" href="plot_load_and_predict.html#sphx-glr-auto-examples-plot-load-and-predict-py"><span class="std std-ref">Load and predict with ONNX Runtime and a very simple model</span></a></p>
<div class="sphx-glr-thumbnail-title">Load and predict with ONNX Runtime and a very simple model</div>
</div><div class="sphx-glr-thumbcontainer" tooltip="*ONNX Runtime* extends the `onnx backend API &lt;https://github.com/onnx/onnx/blob/master/docs/Im..."><img alt="ONNX Runtime Backend for ONNX" src="../images/sphx_glr_plot_backend_thumb.png" />
<p><a class="reference internal" href="plot_backend.html#sphx-glr-auto-examples-plot-backend-py"><span class="std std-ref">ONNX Runtime Backend for ONNX</span></a></p>
<div class="sphx-glr-thumbnail-title">ONNX Runtime Backend for ONNX</div>
</div><div class="sphx-glr-thumbcontainer" tooltip="ONNX format contains metadata related to how the model was produced. It is useful when the mode..."><img alt="Metadata" src="../images/sphx_glr_plot_metadata_thumb.png" />
<p><a class="reference internal" href="plot_metadata.html#sphx-glr-auto-examples-plot-metadata-py"><span class="std std-ref">Metadata</span></a></p>
<div class="sphx-glr-thumbnail-title">Metadata</div>
</div><div class="sphx-glr-thumbcontainer" tooltip="*ONNX Runtime* can profile the execution of the model. This example shows how to interpret the ..."><img alt="Profile the execution of a simple model" src="../images/sphx_glr_plot_profiling_thumb.png" />
<p><a class="reference internal" href="plot_profiling.html#sphx-glr-auto-examples-plot-profiling-py"><span class="std std-ref">Profile the execution of a simple model</span></a></p>
<div class="sphx-glr-thumbnail-title">Profile the execution of a simple model</div>
</div><div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates an end to end scenario starting with the training of a scikit-learn p..."><img alt="Train, convert and predict with ONNX Runtime" src="../images/sphx_glr_plot_convert_pipeline_vectorizer_thumb.png" />
<p><a class="reference internal" href="plot_convert_pipeline_vectorizer.html#sphx-glr-auto-examples-plot-convert-pipeline-vectorizer-py"><span class="std std-ref">Train, convert and predict with ONNX Runtime</span></a></p>
<div class="sphx-glr-thumbnail-title">Train, convert and predict with ONNX Runtime</div>
</div><div class="sphx-glr-thumbcontainer" tooltip="This example looks into several common situations in which *onnxruntime* does not return the mo..."><img alt="Common errors with onnxruntime" src="../images/sphx_glr_plot_common_errors_thumb.png" />
<p><a class="reference internal" href="plot_common_errors.html#sphx-glr-auto-examples-plot-common-errors-py"><span class="std std-ref">Common errors with onnxruntime</span></a></p>
<div class="sphx-glr-thumbnail-title">Common errors with onnxruntime</div>
</div><div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates an end to end scenario starting with the training of a machine learne..."><img alt="Train, convert and predict with ONNX Runtime" src="../images/sphx_glr_plot_train_convert_predict_thumb.png" />
<p><a class="reference internal" href="plot_train_convert_predict.html#sphx-glr-auto-examples-plot-train-convert-predict-py"><span class="std std-ref">Train, convert and predict with ONNX Runtime</span></a></p>
<div class="sphx-glr-thumbnail-title">Train, convert and predict with ONNX Runtime</div>
</div></div><div class="toctree-wrapper compound">
</div>
<div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to load a model and compute the output for an input vector. It al..."><figure class="align-default" id="id2">
<img alt="Load and predict with ONNX Runtime and a very simple model" src="../images/sphx_glr_plot_load_and_predict_thumb.png" />
<figcaption>
<p><span class="caption-text"><a class="reference internal" href="plot_load_and_predict.html#sphx-glr-auto-examples-plot-load-and-predict-py"><span class="std std-ref">Load and predict with ONNX Runtime and a very simple model</span></a></span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
</figcaption>
</figure>
</div><div class="toctree-wrapper compound">
</div>
<div class="sphx-glr-thumbcontainer" tooltip="*ONNX Runtime* extends the `onnx backend API &lt;https://github.com/onnx/onnx/blob/master/docs/Im..."><figure class="align-default" id="id3">
<img alt="ONNX Runtime Backend for ONNX" src="../images/sphx_glr_plot_backend_thumb.png" />
<figcaption>
<p><span class="caption-text"><a class="reference internal" href="plot_backend.html#sphx-glr-auto-examples-plot-backend-py"><span class="std std-ref">ONNX Runtime Backend for ONNX</span></a></span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
</figcaption>
</figure>
</div><div class="toctree-wrapper compound">
</div>
<div class="sphx-glr-thumbcontainer" tooltip="ONNX format contains metadata related to how the model was produced. It is useful when the mode..."><figure class="align-default" id="id4">
<img alt="Metadata" src="../images/sphx_glr_plot_metadata_thumb.png" />
<figcaption>
<p><span class="caption-text"><a class="reference internal" href="plot_metadata.html#sphx-glr-auto-examples-plot-metadata-py"><span class="std std-ref">Metadata</span></a></span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
</figcaption>
</figure>
</div><div class="toctree-wrapper compound">
</div>
<div class="sphx-glr-thumbcontainer" tooltip="*ONNX Runtime* can profile the execution of the model. This example shows how to interpret the ..."><figure class="align-default" id="id5">
<img alt="Profile the execution of a simple model" src="../images/sphx_glr_plot_profiling_thumb.png" />
<figcaption>
<p><span class="caption-text"><a class="reference internal" href="plot_profiling.html#sphx-glr-auto-examples-plot-profiling-py"><span class="std std-ref">Profile the execution of a simple model</span></a></span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
</figcaption>
</figure>
</div><div class="toctree-wrapper compound">
</div>
<div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates an end to end scenario starting with the training of a scikit-learn p..."><figure class="align-default" id="id6">
<img alt="Train, convert and predict with ONNX Runtime" src="../images/sphx_glr_plot_convert_pipeline_vectorizer_thumb.png" />
<figcaption>
<p><span class="caption-text"><a class="reference internal" href="plot_convert_pipeline_vectorizer.html#sphx-glr-auto-examples-plot-convert-pipeline-vectorizer-py"><span class="std std-ref">Train, convert and predict with ONNX Runtime</span></a></span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
</figcaption>
</figure>
</div><div class="toctree-wrapper compound">
</div>
<div class="sphx-glr-thumbcontainer" tooltip="This example looks into several common situations in which *onnxruntime* does not return the mo..."><figure class="align-default" id="id7">
<img alt="Common errors with onnxruntime" src="../images/sphx_glr_plot_common_errors_thumb.png" />
<figcaption>
<p><span class="caption-text"><a class="reference internal" href="plot_common_errors.html#sphx-glr-auto-examples-plot-common-errors-py"><span class="std std-ref">Common errors with onnxruntime</span></a></span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
</figcaption>
</figure>
</div><div class="toctree-wrapper compound">
</div>
<div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates an end to end scenario starting with the training of a machine learne..."><figure class="align-default" id="id8">
<img alt="Train, convert and predict with ONNX Runtime" src="../images/sphx_glr_plot_train_convert_predict_thumb.png" />
<figcaption>
<p><span class="caption-text"><a class="reference internal" href="plot_train_convert_predict.html#sphx-glr-auto-examples-plot-train-convert-predict-py"><span class="std std-ref">Train, convert and predict with ONNX Runtime</span></a></span><a class="headerlink" href="#id8" title="Permalink to this image">¶</a></p>
</figcaption>
</figure>
</div><div class="toctree-wrapper compound">
</div>
<div class="sphx-glr-clear"></div><div class="sphx-glr-footer class sphx-glr-footer-gallery docutils container">
<div class="sphx-glr-footer sphx-glr-footer-gallery docutils container">
<div class="sphx-glr-download sphx-glr-download-python docutils container">
<p><a class="reference download internal" download="" href="../downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">all</span> <span class="pre">examples</span> <span class="pre">in</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">auto_examples_python.zip</span></code></a></p>
</div>
Expand Down Expand Up @@ -139,15 +102,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 All @@ -161,7 +124,7 @@ <h3 id="searchlabel">Quick search</h3>
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<script>document.getElementById('searchbox').style.display = "block"</script>



Expand All @@ -178,7 +141,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 5.1.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
Expand Down
Loading