blob: a2404265c3fe0acf5e22e78d9d790ccafd51efb5 [file] [log] [blame]
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Render &mdash; SystemDS 2.0.0 documentation</title>
<link rel="stylesheet" href="../../static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../static/pygments.css" type="text/css" />
<!--[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 src="../../static/jquery.js"></script>
<script src="../../static/underscore.js"></script>
<script src="../../static/doctools.js"></script>
<script src="../../static/language_data.js"></script>
<script type="text/javascript" src="../../static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Util" href="util.html" />
<link rel="prev" title="Operator Gen" href="operator_gen.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" >
<a href="../../index.html" class="icon icon-home" alt="Documentation Home"> SystemDS
</a>
<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 class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Getting Started:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../getting_started/install.html">Install SystemDS</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../getting_started/simple_examples.html">QuickStart</a></li>
</ul>
<p class="caption"><span class="caption-text">Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../guide/federated.html">Federated Environment</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../guide/algorithms_basics.html">Built-in Algorithms</a></li>
</ul>
<p class="caption"><span class="caption-text">Onnx SystemDS</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../onnx_systemds/onnx_systemds.html">QuickStart Onnx</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../onnx_systemds/onnx_systemds_design.html">Design</a></li>
</ul>
<p class="caption"><span class="caption-text">API</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../operator/algorithms.html">Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="../context/systemds_context.html">SystemDSContext</a></li>
<li class="toctree-l1"><a class="reference internal" href="../matrix/matrix.html">Matrix</a></li>
<li class="toctree-l1"><a class="reference internal" href="../matrix/federated.html">Federated</a></li>
<li class="toctree-l1"><a class="reference internal" href="../operator/operation_node.html">Operation Node</a></li>
<li class="toctree-l1"><a class="reference internal" href="convert.html">Convert</a></li>
<li class="toctree-l1"><a class="reference internal" href="onnx_helper.html">Onnx Helper</a></li>
<li class="toctree-l1"><a class="reference internal" href="operator_gen.html">Operator Gen</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Render</a></li>
<li class="toctree-l1"><a class="reference internal" href="util.html">Util</a></li>
</ul>
<p class="caption"><span class="caption-text">Internals API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../script_building/dag.html">Dag</a></li>
<li class="toctree-l1"><a class="reference internal" href="../script_building/script.html">Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="../utils/converters.html">Converters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../utils/helpers.html">Helpers</a></li>
</ul>
</div>
</div>
</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="../../index.html">SystemDS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li>Render</li>
<li class="wy-breadcrumbs-aside">
<a href="../../sources/api/onnx_systemds/render.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">
<div class="section" id="module-systemds.onnx_systemds.render">
<span id="render"></span><h1>Render<a class="headerlink" href="#module-systemds.onnx_systemds.render" title="Permalink to this headline"></a></h1>
<dl class="py function">
<dt id="systemds.onnx_systemds.render.gen_graph_functions">
<code class="sig-prename descclassname">systemds.onnx_systemds.render.</code><code class="sig-name descname">gen_graph_functions</code><span class="sig-paren">(</span><em class="sig-param">env: jinja2.environment.Environment, main_graph: onnx.onnx_ONNX_REL_1_7_ml_pb2.GraphProto) -&gt; ([&lt;class 'str'&gt;], &lt;class 'str'&gt;, [&lt;class 'str'&gt;]</em><span class="sig-paren">)</span><a class="headerlink" href="#systemds.onnx_systemds.render.gen_graph_functions" title="Permalink to this definition"></a></dt>
<dd><p>Traverses the node tree of the onnx-graph structure and generates a script string for each node,
as well as a string for the required imports together with all functions of sub-graphs.
The resulting lists are correctly ordered for inserting them in the dml script.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>env</strong> – Jinja environment to load the template files</p></li>
<li><p><strong>main_graph</strong> – the onnx graph for which the script shall be generated</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Tuple (imports, main function, sub-graph functions)</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="systemds.onnx_systemds.render.gen_model_header">
<code class="sig-prename descclassname">systemds.onnx_systemds.render.</code><code class="sig-name descname">gen_model_header</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">env</span><span class="p">:</span> <span class="n">jinja2.environment.Environment</span></em>, <em class="sig-param"><span class="n">model</span><span class="p">:</span> <span class="n">onnx.onnx_ONNX_REL_1_7_ml_pb2.ModelProto</span></em><span class="sig-paren">)</span> &#x2192; str<a class="headerlink" href="#systemds.onnx_systemds.render.gen_model_header" title="Permalink to this definition"></a></dt>
<dd><p>Generates the header of the script for the given <cite>model</cite></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>env</strong> – Jinja environment to load the template files</p></li>
<li><p><strong>model</strong> – the onnx model for which the header shall be generated</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the generated header</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="systemds.onnx_systemds.render.gen_node_script">
<code class="sig-prename descclassname">systemds.onnx_systemds.render.</code><code class="sig-name descname">gen_node_script</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">env</span><span class="p">:</span> <span class="n">jinja2.environment.Environment</span></em>, <em class="sig-param"><span class="n">graph</span><span class="p">:</span> <span class="n">onnx.onnx_ONNX_REL_1_7_ml_pb2.GraphProto</span></em>, <em class="sig-param"><span class="n">node</span><span class="p">:</span> <span class="n">onnx.onnx_ONNX_REL_1_7_ml_pb2.NodeProto</span></em><span class="sig-paren">)</span> &#x2192; systemds.onnx_systemds.operator_gen.GeneratedScriptPart<a class="headerlink" href="#systemds.onnx_systemds.render.gen_node_script" title="Permalink to this definition"></a></dt>
<dd><p>Generates a dml script snippet, the required imports and sub-graphs for the given <cite>node</cite></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>env</strong> – Jinja environment to load the template files</p></li>
<li><p><strong>graph</strong> – the onnx graph for which the script shall be generated</p></li>
<li><p><strong>node</strong> – the node for which the dml snippet shall be generated</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The generated script-part</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="systemds.onnx_systemds.render.gen_script">
<code class="sig-prename descclassname">systemds.onnx_systemds.render.</code><code class="sig-name descname">gen_script</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span><span class="p">:</span> <span class="n">onnx.onnx_ONNX_REL_1_7_ml_pb2.ModelProto</span></em>, <em class="sig-param"><span class="n">output_file</span><span class="p">:</span> <span class="n">str</span> <span class="o">=</span> <span class="default_value">None</span></em><span class="sig-paren">)</span> &#x2192; str<a class="headerlink" href="#systemds.onnx_systemds.render.gen_script" title="Permalink to this definition"></a></dt>
<dd><p>Generate the dml script for the given <cite>model</cite> and return it.
If an <cite>output_file</cite> is given, the script is also written to a file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>model</strong> – the model for which the dml script shall be generated</p></li>
<li><p><strong>output_file</strong> – (optional) the file to which the script shall be written</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the generated dml-script</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="systemds.onnx_systemds.render.render_function">
<code class="sig-prename descclassname">systemds.onnx_systemds.render.</code><code class="sig-name descname">render_function</code><span class="sig-paren">(</span><em class="sig-param">env: jinja2.environment.Environment, graph: onnx.onnx_ONNX_REL_1_7_ml_pb2.GraphProto, generated_node_scripts: [&lt;class 'str'&gt;]</em><span class="sig-paren">)</span> &#x2192; str<a class="headerlink" href="#systemds.onnx_systemds.render.render_function" title="Permalink to this definition"></a></dt>
<dd><p>Generates the dml function for the given <cite>graph</cite> and inserts the ‘generated_node_scripts’ in
the function-body.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>env</strong> – Jinja environment to load the template files</p></li>
<li><p><strong>graph</strong> – the graph for which the function shall be generated</p></li>
<li><p><strong>generated_node_scripts</strong> – the node scripts in correct order for the function-body</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the generated function</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="util.html" class="btn btn-neutral float-right" title="Util" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="operator_gen.html" class="btn btn-neutral float-left" title="Operator Gen" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, Apache SystemDS
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>