2019-12-21 01:11:46 +00:00
|
|
|
|
|
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
|
2020-08-13 02:12:50 +00:00
|
|
|
|
<html lang="en">
|
2019-12-21 01:11:46 +00:00
|
|
|
|
<head>
|
|
|
|
|
|
<meta charset="utf-8" />
|
2022-01-04 17:32:40 +00:00
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
|
|
|
2022-08-03 01:27:25 +00:00
|
|
|
|
<title>Metadata — ONNX Runtime 1.12.0 documentation</title>
|
2022-01-04 17:32:40 +00:00
|
|
|
|
<link rel="stylesheet" type="text/css" href="../static/pygments.css" />
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../static/alabaster.css" />
|
2021-02-11 00:34:31 +00:00
|
|
|
|
<link rel="stylesheet" type="text/css" href="../static/graphviz.css" />
|
2022-01-04 17:32:40 +00:00
|
|
|
|
<link rel="stylesheet" type="text/css" href="../static/sg_gallery.css" />
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../static/sg_gallery-binder.css" />
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../static/sg_gallery-dataframe.css" />
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../static/sg_gallery-rendered-html.css" />
|
|
|
|
|
|
<script data-url_root="../" id="documentation_options" src="../static/documentation_options.js"></script>
|
2021-02-11 00:34:31 +00:00
|
|
|
|
<script src="../static/jquery.js"></script>
|
|
|
|
|
|
<script src="../static/underscore.js"></script>
|
|
|
|
|
|
<script src="../static/doctools.js"></script>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
2020-04-06 22:52:48 +00:00
|
|
|
|
<link rel="next" title="Profile the execution of a simple model" href="plot_profiling.html" />
|
2019-12-21 01:11:46 +00:00
|
|
|
|
<link rel="prev" title="ONNX Runtime Backend for ONNX" href="plot_backend.html" />
|
|
|
|
|
|
|
2021-02-11 00:34:31 +00:00
|
|
|
|
<link rel="stylesheet" href="../static/custom.css" type="text/css" />
|
2019-12-21 01:11:46 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
|
|
|
|
|
|
|
|
|
|
|
</head><body>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="document">
|
|
|
|
|
|
<div class="documentwrapper">
|
|
|
|
|
|
<div class="bodywrapper">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="sphx-glr-download-link-note admonition note">
|
|
|
|
|
|
<p class="admonition-title">Note</p>
|
2021-03-09 18:21:38 +00:00
|
|
|
|
<p>Click <a class="reference internal" href="#sphx-glr-download-auto-examples-plot-metadata-py"><span class="std std-ref">here</span></a>
|
|
|
|
|
|
to download the full example code</p>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
</div>
|
2022-01-04 17:32:40 +00:00
|
|
|
|
<section class="sphx-glr-example-title" id="metadata">
|
2019-12-21 01:11:46 +00:00
|
|
|
|
<span id="sphx-glr-auto-examples-plot-metadata-py"></span><h1>Metadata<a class="headerlink" href="#metadata" title="Permalink to this headline">¶</a></h1>
|
|
|
|
|
|
<p>ONNX format contains metadata related to how the
|
|
|
|
|
|
model was produced. It is useful when the model
|
|
|
|
|
|
is deployed to production to keep track of which
|
|
|
|
|
|
instance was used at a specific time.
|
|
|
|
|
|
Let’s see how to do that with a simple
|
|
|
|
|
|
logistic regression model trained with
|
|
|
|
|
|
<em>scikit-learn</em> and converted with <em>sklearn-onnx</em>.</p>
|
2022-01-04 17:32:40 +00:00
|
|
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">onnxruntime.datasets</span> <span class="k">import</span> <span class="n">get_example</span>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
<span class="n">example</span> <span class="o">=</span> <span class="n">get_example</span><span class="p">(</span><span class="s2">"logreg_iris.onnx"</span><span class="p">)</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kn">import</span> <span class="nn">onnx</span>
|
|
|
|
|
|
<span class="n">model</span> <span class="o">=</span> <span class="n">onnx</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">example</span><span class="p">)</span>
|
|
|
|
|
|
|
2020-08-13 02:12:50 +00:00
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"doc_string=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">doc_string</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"domain=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">domain</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"ir_version=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">ir_version</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"metadata_props=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">metadata_props</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"model_version=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">model_version</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"producer_name=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">producer_name</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"producer_version=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">producer_version</span><span class="p">))</span>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
</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>doc_string=
|
|
|
|
|
|
domain=onnxml
|
|
|
|
|
|
ir_version=3
|
|
|
|
|
|
metadata_props=[]
|
|
|
|
|
|
model_version=0
|
|
|
|
|
|
producer_name=OnnxMLTools
|
|
|
|
|
|
producer_version=1.2.0.0116
|
|
|
|
|
|
</pre></div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<p>With <em>ONNX Runtime</em>:</p>
|
2022-01-04 17:32:40 +00:00
|
|
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">onnxruntime</span> <span class="k">as</span> <span class="nn">rt</span>
|
|
|
|
|
|
<span class="n">sess</span> <span class="o">=</span> <span class="n">rt</span><span class="o">.</span><span class="n">InferenceSession</span><span class="p">(</span><span class="n">example</span><span class="p">,</span> <span class="n">providers</span><span class="o">=</span><span class="n">rt</span><span class="o">.</span><span class="n">get_available_providers</span><span class="p">())</span>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
<span class="n">meta</span> <span class="o">=</span> <span class="n">sess</span><span class="o">.</span><span class="n">get_modelmeta</span><span class="p">()</span>
|
|
|
|
|
|
|
2020-08-13 02:12:50 +00:00
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"custom_metadata_map=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">meta</span><span class="o">.</span><span class="n">custom_metadata_map</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"description=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">meta</span><span class="o">.</span><span class="n">description</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"domain=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">meta</span><span class="o">.</span><span class="n">domain</span><span class="p">,</span> <span class="n">meta</span><span class="o">.</span><span class="n">domain</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"graph_name=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">meta</span><span class="o">.</span><span class="n">graph_name</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"producer_name=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">meta</span><span class="o">.</span><span class="n">producer_name</span><span class="p">))</span>
|
|
|
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"version=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">meta</span><span class="o">.</span><span class="n">version</span><span class="p">))</span>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
</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>custom_metadata_map={}
|
|
|
|
|
|
description=
|
|
|
|
|
|
domain=onnxml
|
|
|
|
|
|
graph_name=3c59201b940f410fa29dc71ea9d5767d
|
|
|
|
|
|
producer_name=OnnxMLTools
|
|
|
|
|
|
version=0
|
|
|
|
|
|
</pre></div>
|
|
|
|
|
|
</div>
|
2022-08-03 01:27:25 +00:00
|
|
|
|
<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes 0.004 seconds)</p>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-plot-metadata-py">
|
2020-08-13 02:12:50 +00:00
|
|
|
|
<div class="sphx-glr-download sphx-glr-download-python docutils container">
|
2021-03-09 18:21:38 +00:00
|
|
|
|
<p><a class="reference download internal" download="" href="../downloads/932fe1ee7f48f55a6155d2f378bc85a0/plot_metadata.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_metadata.py</span></code></a></p>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
</div>
|
2020-08-13 02:12:50 +00:00
|
|
|
|
<div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
|
2021-03-09 18:21:38 +00:00
|
|
|
|
<p><a class="reference download internal" download="" href="../downloads/940d20a5bdb46eb51fb878fbb3bd928d/plot_metadata.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">plot_metadata.ipynb</span></code></a></p>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
2020-08-13 02:12:50 +00:00
|
|
|
|
<p class="sphx-glr-signature"><a class="reference external" href="https://sphinx-gallery.github.io">Gallery generated by Sphinx-Gallery</a></p>
|
2022-01-04 17:32:40 +00:00
|
|
|
|
</section>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
<div class="sphinxsidebarwrapper">
|
|
|
|
|
|
<p class="logo"><a href="../index.html">
|
2021-02-11 00:34:31 +00:00
|
|
|
|
<img class="logo" src="../static/ONNX_Runtime_icon.png" alt="Logo"/>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
</a></p>
|
|
|
|
|
|
<h1 class="logo"><a href="../index.html">ONNX Runtime</a></h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Navigation</h3>
|
2021-03-09 18:21:38 +00:00
|
|
|
|
<ul>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
|
2022-03-16 01:13:11 +00:00
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="../api_summary.html">API</a></li>
|
2021-03-09 18:21:38 +00:00
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="index.html">Gallery of examples</a></li>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="relations">
|
|
|
|
|
|
<h3>Related Topics</h3>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="../index.html">Documentation overview</a><ul>
|
|
|
|
|
|
<li><a href="index.html">Gallery of examples</a><ul>
|
|
|
|
|
|
<li>Previous: <a href="plot_backend.html" title="previous chapter">ONNX Runtime Backend for ONNX</a></li>
|
2020-04-06 22:52:48 +00:00
|
|
|
|
<li>Next: <a href="plot_profiling.html" title="next chapter">Profile the execution of a simple model</a></li>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
</ul></li>
|
|
|
|
|
|
</ul></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">
|
2022-01-04 17:32:40 +00:00
|
|
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
<input type="submit" value="Go" />
|
|
|
|
|
|
</form>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
2020-08-13 02:12:50 +00:00
|
|
|
|
<script>$('#searchbox').show(0);</script>
|
2020-04-06 22:52:48 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-12-21 01:11:46 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="footer">
|
2021-02-11 00:34:31 +00:00
|
|
|
|
©2018-2021, Microsoft.
|
2019-12-21 01:11:46 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
2022-08-03 01:27:25 +00:00
|
|
|
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
|
2020-04-06 22:52:48 +00:00
|
|
|
|
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
2019-12-21 01:11:46 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
2021-02-11 00:34:31 +00:00
|
|
|
|
<a href="../sources/auto_examples/plot_metadata.rst.txt"
|
2019-12-21 01:11:46 +00:00
|
|
|
|
rel="nofollow">Page source</a>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
