Skip to content

Update python documentation #8051

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

Closed
xzhu1900 wants to merge 1 commit into from
Closed

Update python documentation #8051

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
729 changes: 729 additions & 0 deletions python/content.html
View file
Open in desktop

Large diffs are not rendered by default.

432 changes: 267 additions & 165 deletions python/genindex.html
View file
Open in desktop

Large diffs are not rendered by default.

280 changes: 197 additions & 83 deletions python/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,65 +1,133 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Bindings for ONNX Runtime &#8212; ONNX Runtime 1.7.0 documentation</title>
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="stylesheet" href="static/alabaster.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="static/gallery.css" />
<link rel="stylesheet" type="text/css" href="static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="static/gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="static/gallery-rendered-html.css" />
<script id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
<script src="static/jquery.js"></script>
<script src="static/underscore.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="Tutorial" href="tutorial.html" />

<link rel="stylesheet" href="static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>ORTModule documentation &mdash; ORTModule 0.1 documentation</title>



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








<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>

<!--[if lt IE 9]>
<script src="static/js/html5shiv.min.js"></script>
<![endif]-->


<script type="text/javascript" id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
<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/doctools.js"></script>

<script type="text/javascript" src="static/js/theme.js"></script>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="What is new" href="content.html" />
</head>

<body class="wy-body-for-nav">


<div class="wy-grid-for-nav">

<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >


<div class="body" role="main">

<a href="#" class="icon icon-home"> ORTModule



</a>



<div class="section" id="python-bindings-for-onnx-runtime">
<h1>Python Bindings for ONNX Runtime<a class="headerlink" href="#python-bindings-for-onnx-runtime" title="Permalink to this headline">¶</a></h1>
<p>ONNX Runtime is a performance-focused scoring engine for Open Neural Network Exchange (ONNX) models.
For more information on ONNX Runtime, please see <a class="reference external" href="https://aka.ms/onnxruntime/">aka.ms/onnxruntime</a> or the <a class="reference external" href="https://github.com/microsoft/onnxruntime/">Github project</a>.</p>
<div class="toctree-wrapper compound">
<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="auto_examples/index.html">Gallery of examples</a></li>
</ul>
</div>

<div class="version">
0.1
</div>




<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>

</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="content.html">What is new</a></li>
<li class="toctree-l1"><a class="reference internal" href="content.html#overview">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="content.html#module-onnxruntime.training.ortmodule.ortmodule">API</a></li>
</ul>



</div>

</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#">
<img class="logo" src="static/ONNX_Runtime_icon.png" alt="Logo"/>
</a></p>
<h1 class="logo"><a href="#">ONNX Runtime</a></h1>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">ORTModule</a>

</nav>


<div class="wy-nav-content">

<div class="rst-content">












Expand All @@ -68,57 +136,103 @@ <h1 class="logo"><a href="#">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="auto_examples/index.html">Gallery of examples</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>

<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">

<li><a href="#" class="icon icon-home"></a> &raquo;</li>

<li>ORTModule documentation</li>


<li class="wy-breadcrumbs-aside">


<a href="sources/index.rst.txt" rel="nofollow"> View page source</a>


</li>

</ul>


<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="ortmodule-documentation">
<h1>ORTModule documentation<a class="headerlink" href="#ortmodule-documentation" title="Permalink to this headline">¶</a></h1>
<p>ORTModule is a PyTorch frontend API for <a class="reference external" href="https://www.onnxruntime.ai/docs/">ONNX Runtime</a>,
a cross-platform inferencing and training accelerator.</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="tutorial.html" title="next chapter">Tutorial</a></li>
</ul></li>
<li class="toctree-l1"><a class="reference internal" href="content.html">What is new</a><ul>
<li class="toctree-l2"><a class="reference internal" href="content.html#version-0-1">Version 0.1</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="content.html#overview">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="content.html#module-onnxruntime.training.ortmodule.ortmodule">API</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>


</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>


</div>

</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="content.html" class="btn btn-neutral float-right" title="What is new" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>
&#169; Copyright 2018-2021, Microsoft.

</p>
</div>



Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2018-2021, Microsoft.

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

|
<a href="sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>


</section>

</div>


<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>




</body>


</body>
</html>
Binary file modified python/objects.inv
View file
Open in desktop
Binary file not shown.
Loading