[Sphinx Documentation] First draft of end2end flow page and references to flow step pages

docs/finn/_build/html/_sources/brevitas_export.rst.txt

+.. _brevitas_export:
+
 ***************
 Brevitas Export
 ***************

docs/finn/_build/html/_sources/end_to_end_flow.rst.txt

@@ -2,9 +2,26 @@
 End-to-End Flow
 ***************
 
-The following image shows the end-to-end flow of FINN.
+The following image shows the end-to-end flow of FINN. As you can see in the picture, FINN has a high modularity and has the property that the flow can be stopped at any point and the intermediate result can be used for further processing or other purposes. This enables a wide range of users to benefit from FINN, even if they do not use the whole flow.
 
 .. image:: ../../notebooks/finn-design-flow-example.svg
    :scale: 50%
    :align: center
 
+Flow structure
+==============
+
+The cylinder-like fields show the state of the network representation in the respective step. The rectangular fields represent the transformations that are applied to the network to achieve a certain result. The diagram is divided into five blocks, each of it includes several flow steps. The flow starts in top left corner with Brevitas export (pink block), followed by the preparation of the network (grey block) for the Vivado HLS and Vivado IPI (yellow block). There is also a section for testing and verification in software (green block) and the hardware generation and deployment on the PYNQ board (red block). For more details about the different flow sections, please have a look at the corresponding pages on this website.
+
+* :ref:`brevitas_export`
+
+* :ref:`nw_prep`
+
+* :ref:`vivado_synth`
+
+* :ref:`pynq_deploy`
+
+* :ref:`verification`
+
+
+

docs/finn/_build/html/_sources/nw_prep.rst.txt

+.. _nw_prep:
+
 *******************
 Network Preparation
 *******************

docs/finn/_build/html/_sources/pynq_deploy.rst.txt

+.. _pynq_deploy:
+
 ***************
 PYNQ Deployment
 ***************

docs/finn/_build/html/_sources/verification.rst.txt

+.. _verification:
+
 ***********************
 Functional Verification
 ***********************

docs/finn/_build/html/_sources/vivado_synth.rst.txt

-*******************************
-Vivado HLS and Vivado Synthesis
-*******************************
+.. _vivado_synth:
+
+*************************
+Vivado HLS and Vivado IPI 
+*************************
 
 .. note:: **Here will be soon a detailed description of how Vivado is used in FINN.**
 

docs/finn/_build/html/brevitas_export.html

@@ -87,7 +87,7 @@
 <li class="toctree-l1"><a class="reference internal" href="internals.html">Internals</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Brevitas Export</a></li>
 <li class="toctree-l1"><a class="reference internal" href="nw_prep.html">Network Preparation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado Synthesis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado IPI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pynq_deploy.html">PYNQ Deployment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="verification.html">Functional Verification</a></li>
 <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">Source Code</a></li>
@@ -157,7 +157,7 @@
            <div itemprop="articleBody">
             
   <div class="section" id="brevitas-export">
-<h1>Brevitas Export<a class="headerlink" href="#brevitas-export" title="Permalink to this headline">¶</a></h1>
+<span id="id1"></span><h1>Brevitas Export<a class="headerlink" href="#brevitas-export" title="Permalink to this headline">¶</a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p><strong>Here will be soon a detailed description of brevitas export in FINN.</strong></p>

docs/finn/_build/html/end_to_end_flow.html

@@ -83,11 +83,14 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">End-to-End Flow</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">End-to-End Flow</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#flow-structure">Flow structure</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="internals.html">Internals</a></li>
 <li class="toctree-l1"><a class="reference internal" href="brevitas_export.html">Brevitas Export</a></li>
 <li class="toctree-l1"><a class="reference internal" href="nw_prep.html">Network Preparation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado Synthesis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado IPI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pynq_deploy.html">PYNQ Deployment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="verification.html">Functional Verification</a></li>
 <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">Source Code</a></li>
@@ -158,8 +161,19 @@
             
   <div class="section" id="end-to-end-flow">
 <h1>End-to-End Flow<a class="headerlink" href="#end-to-end-flow" title="Permalink to this headline">¶</a></h1>
-<p>The following image shows the end-to-end flow of FINN.</p>
+<p>The following image shows the end-to-end flow of FINN. As you can see in the picture, FINN has a high modularity and has the property that the flow can be stopped at any point and the intermediate result can be used for further processing or other purposes. This enables a wide range of users to benefit from FINN, even if they do not use the whole flow.</p>
 <a class="reference internal image-reference" href="_images/finn-design-flow-example.svg"><img alt="_images/finn-design-flow-example.svg" class="align-center" src="_images/finn-design-flow-example.svg" /></a>
+<div class="section" id="flow-structure">
+<h2>Flow structure<a class="headerlink" href="#flow-structure" title="Permalink to this headline">¶</a></h2>
+<p>The cylinder-like fields show the state of the network representation in the respective step. The rectangular fields represent the transformations that are applied to the network to achieve a certain result. The diagram is divided into five blocks, each of it includes several flow steps. The flow starts in top left corner with Brevitas export (pink block), followed by the preparation of the network (grey block) for the Vivado HLS and Vivado IPI (yellow block). There is also a section for testing and verification in software (green block) and the hardware generation and deployment on the PYNQ board (red block). For more details about the different flow sections, please have a look at the corresponding pages on this website.</p>
+<ul class="simple">
+<li><p><a class="reference internal" href="brevitas_export.html#brevitas-export"><span class="std std-ref">Brevitas Export</span></a></p></li>
+<li><p><a class="reference internal" href="nw_prep.html#nw-prep"><span class="std std-ref">Network Preparation</span></a></p></li>
+<li><p><a class="reference internal" href="vivado_synth.html#vivado-synth"><span class="std std-ref">Vivado HLS and Vivado IPI</span></a></p></li>
+<li><p><a class="reference internal" href="pynq_deploy.html#pynq-deploy"><span class="std std-ref">PYNQ Deployment</span></a></p></li>
+<li><p><a class="reference internal" href="verification.html#verification"><span class="std std-ref">Functional Verification</span></a></p></li>
+</ul>
+</div>
 </div>
 
 

docs/finn/_build/html/genindex.html

@@ -86,7 +86,7 @@
 <li class="toctree-l1"><a class="reference internal" href="internals.html">Internals</a></li>
 <li class="toctree-l1"><a class="reference internal" href="brevitas_export.html">Brevitas Export</a></li>
 <li class="toctree-l1"><a class="reference internal" href="nw_prep.html">Network Preparation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado Synthesis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado IPI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pynq_deploy.html">PYNQ Deployment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="verification.html">Functional Verification</a></li>
 <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">Source Code</a></li>

docs/finn/_build/html/getting_started.html

@@ -98,7 +98,7 @@
 <li class="toctree-l1"><a class="reference internal" href="internals.html">Internals</a></li>
 <li class="toctree-l1"><a class="reference internal" href="brevitas_export.html">Brevitas Export</a></li>
 <li class="toctree-l1"><a class="reference internal" href="nw_prep.html">Network Preparation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado Synthesis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado IPI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pynq_deploy.html">PYNQ Deployment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="verification.html">Functional Verification</a></li>
 <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">Source Code</a></li>

docs/finn/_build/html/index.html

@@ -86,7 +86,7 @@
 <li class="toctree-l1"><a class="reference internal" href="internals.html">Internals</a></li>
 <li class="toctree-l1"><a class="reference internal" href="brevitas_export.html">Brevitas Export</a></li>
 <li class="toctree-l1"><a class="reference internal" href="nw_prep.html">Network Preparation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado Synthesis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado IPI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pynq_deploy.html">PYNQ Deployment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="verification.html">Functional Verification</a></li>
 <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">Source Code</a></li>

docs/finn/_build/html/internals.html

@@ -101,7 +101,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="brevitas_export.html">Brevitas Export</a></li>
 <li class="toctree-l1"><a class="reference internal" href="nw_prep.html">Network Preparation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado Synthesis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado IPI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pynq_deploy.html">PYNQ Deployment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="verification.html">Functional Verification</a></li>
 <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">Source Code</a></li>

docs/finn/_build/html/nw_prep.html

@@ -35,7 +35,7 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Vivado HLS and Vivado Synthesis" href="vivado_synth.html" />
+    <link rel="next" title="Vivado HLS and Vivado IPI" href="vivado_synth.html" />
     <link rel="prev" title="Brevitas Export" href="brevitas_export.html" /> 
 </head>
 
@@ -87,7 +87,7 @@
 <li class="toctree-l1"><a class="reference internal" href="internals.html">Internals</a></li>
 <li class="toctree-l1"><a class="reference internal" href="brevitas_export.html">Brevitas Export</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Network Preparation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado Synthesis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="vivado_synth.html">Vivado HLS and Vivado IPI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pynq_deploy.html">PYNQ Deployment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="verification.html">Functional Verification</a></li>
 <li class="toctree-l1"><a class="reference internal" href="source_code/finn.html">Source Code</a></li>
@@ -157,7 +157,7 @@
            <div itemprop="articleBody">
             
   <div class="section" id="network-preparation">
-<h1>Network Preparation<a class="headerlink" href="#network-preparation" title="Permalink to this headline">¶</a></h1>
+<span id="nw-prep"></span><h1>Network Preparation<a class="headerlink" href="#network-preparation" title="Permalink to this headline">¶</a></h1>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p><strong>Here will be soon a detailed description of how the network preparation in FINN works.</strong></p>
@@ -172,7 +172,7 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="vivado_synth.html" class="btn btn-neutral float-right" title="Vivado HLS and Vivado Synthesis" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="vivado_synth.html" class="btn btn-neutral float-right" title="Vivado HLS and Vivado IPI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
         <a href="brevitas_export.html" class="btn btn-neutral float-left" title="Brevitas Export" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>