Update Sphinx Documentation

Author: actions-user

_sources/autodoc/hls4ml.model.optimizer.passes.rst.txt

@@ -140,6 +140,14 @@ hls4ml.model.optimizer.passes.multi\_dense module
    :undoc-members:
    :show-inheritance:
 
+hls4ml.model.optimizer.passes.pad\_const module
+-----------------------------------------------
+
+.. automodule:: hls4ml.model.optimizer.passes.pad_const
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 hls4ml.model.optimizer.passes.qkeras module
 -------------------------------------------
 

autodoc/hls4ml.converters.html

@@ -360,6 +360,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 </li>
 <li class="toctree-l2"><a class="reference internal" href="hls4ml.converters.onnx.html#module-hls4ml.converters.onnx.reshape">hls4ml.converters.onnx.reshape module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="hls4ml.converters.onnx.html#hls4ml.converters.onnx.reshape.parse_flatten_layer"><code class="docutils literal notranslate"><span class="pre">parse_flatten_layer()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="hls4ml.converters.onnx.html#hls4ml.converters.onnx.reshape.parse_pad_layer"><code class="docutils literal notranslate"><span class="pre">parse_pad_layer()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="hls4ml.converters.onnx.html#hls4ml.converters.onnx.reshape.parse_reshape_layer"><code class="docutils literal notranslate"><span class="pre">parse_reshape_layer()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="hls4ml.converters.onnx.html#hls4ml.converters.onnx.reshape.parse_resize_layer"><code class="docutils literal notranslate"><span class="pre">parse_resize_layer()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="hls4ml.converters.onnx.html#hls4ml.converters.onnx.reshape.parse_transpose_layer"><code class="docutils literal notranslate"><span class="pre">parse_transpose_layer()</span></code></a></li>

autodoc/hls4ml.converters.onnx.html

@@ -211,6 +211,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <span class="sig-prename descclassname"><span class="pre">hls4ml.converters.onnx.reshape.</span></span><span class="sig-name descname"><span class="pre">parse_flatten_layer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_names</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_shapes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">graph</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#hls4ml.converters.onnx.reshape.parse_flatten_layer" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="hls4ml.converters.onnx.reshape.parse_pad_layer">
+<span class="sig-prename descclassname"><span class="pre">hls4ml.converters.onnx.reshape.</span></span><span class="sig-name descname"><span class="pre">parse_pad_layer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_names</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_shapes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">graph</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#hls4ml.converters.onnx.reshape.parse_pad_layer" title="Link to this definition"></a></dt>
+<dd></dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="hls4ml.converters.onnx.reshape.parse_reshape_layer">
 <span class="sig-prename descclassname"><span class="pre">hls4ml.converters.onnx.reshape.</span></span><span class="sig-name descname"><span class="pre">parse_reshape_layer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_names</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_shapes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">graph</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#hls4ml.converters.onnx.reshape.parse_reshape_layer" title="Link to this definition"></a></dt>

autodoc/hls4ml.model.html

@@ -190,6 +190,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 <li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.merge_const">hls4ml.model.optimizer.passes.merge_const module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.move_scales">hls4ml.model.optimizer.passes.move_scales module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.multi_dense">hls4ml.model.optimizer.passes.multi_dense module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.pad_const">hls4ml.model.optimizer.passes.pad_const module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.qkeras">hls4ml.model.optimizer.passes.qkeras module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.quant_opt">hls4ml.model.optimizer.passes.quant_opt module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.reshape_const">hls4ml.model.optimizer.passes.reshape_const module</a></li>

autodoc/hls4ml.model.optimizer.html

@@ -396,6 +396,14 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
 </li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.pad_const">hls4ml.model.optimizer.passes.pad_const module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.pad_const.PaddingConstant"><code class="docutils literal notranslate"><span class="pre">PaddingConstant</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.pad_const.PaddingConstant.match"><code class="docutils literal notranslate"><span class="pre">PaddingConstant.match()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.pad_const.PaddingConstant.transform"><code class="docutils literal notranslate"><span class="pre">PaddingConstant.transform()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.qkeras">hls4ml.model.optimizer.passes.qkeras module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.qkeras.ExtractTernaryThreshold"><code class="docutils literal notranslate"><span class="pre">ExtractTernaryThreshold</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.qkeras.ExtractTernaryThreshold.match"><code class="docutils literal notranslate"><span class="pre">ExtractTernaryThreshold.match()</span></code></a></li>

autodoc/hls4ml.model.optimizer.passes.html

@@ -1366,6 +1366,34 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 
 </dd></dl>
 
+</section>
+<section id="module-hls4ml.model.optimizer.passes.pad_const">
+<span id="hls4ml-model-optimizer-passes-pad-const-module"></span><h2>hls4ml.model.optimizer.passes.pad_const module<a class="headerlink" href="#module-hls4ml.model.optimizer.passes.pad_const" title="Link to this heading"></a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="hls4ml.model.optimizer.passes.pad_const.PaddingConstant">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">hls4ml.model.optimizer.passes.pad_const.</span></span><span class="sig-name descname"><span class="pre">PaddingConstant</span></span><a class="headerlink" href="#hls4ml.model.optimizer.passes.pad_const.PaddingConstant" title="Link to this definition"></a></dt>
+<dd><p>Bases: <a class="reference internal" href="hls4ml.model.optimizer.html#hls4ml.model.optimizer.optimizer.OptimizerPass" title="hls4ml.model.optimizer.optimizer.OptimizerPass"><code class="xref py py-class docutils literal notranslate"><span class="pre">OptimizerPass</span></code></a></p>
+<p>ONNX has the padding come as an input, not a parameter. This removes the Constant node from the input.
+The constant value was already used; this is just a cleanup uptimization.</p>
+<dl class="py method">
+<dt class="sig sig-object py" id="hls4ml.model.optimizer.passes.pad_const.PaddingConstant.match">
+<span class="sig-name descname"><span class="pre">match</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#hls4ml.model.optimizer.passes.pad_const.PaddingConstant.match" title="Link to this definition"></a></dt>
+<dd><p>Predicate to match on a given node.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>node</strong> (<a class="reference internal" href="hls4ml.model.html#hls4ml.model.layers.Layer" title="hls4ml.model.layers.Layer"><em>Layer</em></a>) – Node in the model graph to try matching the optimizer on.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="hls4ml.model.optimizer.passes.pad_const.PaddingConstant.transform">
+<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#hls4ml.model.optimizer.passes.pad_const.PaddingConstant.transform" title="Link to this definition"></a></dt>
+<dd><p>Remove Constant node(s) from the graph. Note, padding is already present in ZeroPadding node.</p>
+</dd></dl>
+
+</dd></dl>
+
 </section>
 <section id="module-hls4ml.model.optimizer.passes.qkeras">
 <span id="hls4ml-model-optimizer-passes-qkeras-module"></span><h2>hls4ml.model.optimizer.passes.qkeras module<a class="headerlink" href="#module-hls4ml.model.optimizer.passes.qkeras" title="Link to this heading"></a></h2>

genindex.html

@@ -2685,15 +2685,15 @@ <h2 id="H">H</h2>
         <li><a href="autodoc/hls4ml.backends.vivado.passes.html#module-hls4ml.backends.vivado.passes.pipeline_style">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     hls4ml.backends.vivado.passes.pointwise
 
       <ul>
         <li><a href="autodoc/hls4ml.backends.vivado.passes.html#module-hls4ml.backends.vivado.passes.pointwise">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     hls4ml.backends.vivado.passes.pooling_templates
 
@@ -3294,6 +3294,13 @@ <h2 id="H">H</h2>
 
       <ul>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.multi_dense">module</a>
+</li>
+      </ul></li>
+      <li>
+    hls4ml.model.optimizer.passes.pad_const
+
+      <ul>
+        <li><a href="autodoc/hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.pad_const">module</a>
 </li>
       </ul></li>
       <li>
@@ -4184,6 +4191,8 @@ <h2 id="M">M</h2>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.move_scales.ScaleDownMatMul.match">(hls4ml.model.optimizer.passes.move_scales.ScaleDownMatMul method)</a>
 </li>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.multi_dense.ReplaceMultidimensionalDenseWithConv.match">(hls4ml.model.optimizer.passes.multi_dense.ReplaceMultidimensionalDenseWithConv method)</a>
+</li>
+        <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.pad_const.PaddingConstant.match">(hls4ml.model.optimizer.passes.pad_const.PaddingConstant method)</a>
 </li>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.qkeras.ExtractTernaryThreshold.match">(hls4ml.model.optimizer.passes.qkeras.ExtractTernaryThreshold method)</a>
 </li>
@@ -4663,6 +4672,8 @@ <h2 id="M">M</h2>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.move_scales">hls4ml.model.optimizer.passes.move_scales</a>
 </li>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.multi_dense">hls4ml.model.optimizer.passes.multi_dense</a>
+</li>
+        <li><a href="autodoc/hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.pad_const">hls4ml.model.optimizer.passes.pad_const</a>
 </li>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.qkeras">hls4ml.model.optimizer.passes.qkeras</a>
 </li>
@@ -4882,6 +4893,8 @@ <h2 id="P">P</h2>
       <li><a href="autodoc/hls4ml.backends.fpga.html#hls4ml.backends.fpga.fpga_types.PackedTypeConverter">PackedTypeConverter (class in hls4ml.backends.fpga.fpga_types)</a>
 </li>
       <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.bit_exact.pad_arrs">pad_arrs() (in module hls4ml.model.optimizer.passes.bit_exact)</a>
+</li>
+      <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.pad_const.PaddingConstant">PaddingConstant (class in hls4ml.model.optimizer.passes.pad_const)</a>
 </li>
       <li><a href="autodoc/hls4ml.backends.catapult.passes.html#hls4ml.backends.catapult.passes.core_templates.ParamActivationConfigTemplate">ParamActivationConfigTemplate (class in hls4ml.backends.catapult.passes.core_templates)</a>
 
@@ -5020,6 +5033,8 @@ <h2 id="P">P</h2>
       <li><a href="autodoc/hls4ml.report.html#hls4ml.report.oneapi_report.parse_oneapi_report">parse_oneapi_report() (in module hls4ml.report.oneapi_report)</a>
 </li>
       <li><a href="autodoc/hls4ml.converters.html#hls4ml.converters.onnx_to_hls.parse_onnx_model">parse_onnx_model() (in module hls4ml.converters.onnx_to_hls)</a>
+</li>
+      <li><a href="autodoc/hls4ml.converters.onnx.html#hls4ml.converters.onnx.reshape.parse_pad_layer">parse_pad_layer() (in module hls4ml.converters.onnx.reshape)</a>
 </li>
       <li><a href="autodoc/hls4ml.converters.keras.html#hls4ml.converters.keras.reshape.parse_permute_layer">parse_permute_layer() (in module hls4ml.converters.keras.reshape)</a>
 </li>
@@ -5061,10 +5076,10 @@ <h2 id="P">P</h2>
         <li><a href="autodoc/hls4ml.converters.pytorch.html#hls4ml.converters.pytorch.reshape.parse_reshape_layer">(in module hls4ml.converters.pytorch.reshape)</a>
 </li>
       </ul></li>
-      <li><a href="autodoc/hls4ml.converters.onnx.html#hls4ml.converters.onnx.reshape.parse_resize_layer">parse_resize_layer() (in module hls4ml.converters.onnx.reshape)</a>
-</li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autodoc/hls4ml.converters.onnx.html#hls4ml.converters.onnx.reshape.parse_resize_layer">parse_resize_layer() (in module hls4ml.converters.onnx.reshape)</a>
+</li>
       <li><a href="autodoc/hls4ml.converters.keras.html#hls4ml.converters.keras.recurrent.parse_rnn_layer">parse_rnn_layer() (in module hls4ml.converters.keras.recurrent)</a>
 
       <ul>
@@ -6019,6 +6034,8 @@ <h2 id="T">T</h2>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.move_scales.ScaleDownMatMul.transform">(hls4ml.model.optimizer.passes.move_scales.ScaleDownMatMul method)</a>
 </li>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.multi_dense.ReplaceMultidimensionalDenseWithConv.transform">(hls4ml.model.optimizer.passes.multi_dense.ReplaceMultidimensionalDenseWithConv method)</a>
+</li>
+        <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.pad_const.PaddingConstant.transform">(hls4ml.model.optimizer.passes.pad_const.PaddingConstant method)</a>
 </li>
         <li><a href="autodoc/hls4ml.model.optimizer.passes.html#hls4ml.model.optimizer.passes.qkeras.ExtractTernaryThreshold.transform">(hls4ml.model.optimizer.passes.qkeras.ExtractTernaryThreshold method)</a>
 </li>

intro/status.html

@@ -140,7 +140,7 @@
 <h1>Status and Features<a class="headerlink" href="#status-and-features" title="Link to this heading"></a></h1>
 <section id="status">
 <h2>Status<a class="headerlink" href="#status" title="Link to this heading"></a></h2>
-<p>The latest version (built from <code class="docutils literal notranslate"><span class="pre">main</span></code>) is 1.2.0.dev81+gf43776dd.
+<p>The latest version (built from <code class="docutils literal notranslate"><span class="pre">main</span></code>) is 1.2.0.dev82+gb493ea7f.
 The stable version (released on PyPI) is 1.1.0.
 See the <a class="reference internal" href="release_notes.html#release-notes"><span class="std std-ref">Release Notes</span></a> section for a changelog.</p>
 </section>

objects.inv

@@ -1097,6 +1097,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="autodoc/hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.multi_dense"><code class="xref">hls4ml.model.optimizer.passes.multi_dense</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="autodoc/hls4ml.model.optimizer.passes.html#module-hls4ml.model.optimizer.passes.pad_const"><code class="xref">hls4ml.model.optimizer.passes.pad_const</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;