Skip to content
Snippets Groups Projects
Commit fc3b2a85 authored by auphelia's avatar auphelia
Browse files

[Sphinx documentation] Add section about what finn is

parent 24667b10
No related branches found
No related tags found
No related merge requests found
No preview for this file type
No preview for this file type
...@@ -3,8 +3,20 @@ ...@@ -3,8 +3,20 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
****
FINN FINN
================================ ****
FINN is an experimental framework from Xilinx Research Labs to explore deep neural network inference on FPGAs. It specifically targets quantized neural networks, with emphasis on generating dataflow-style architectures customized for each network. It is not intended to be a generic DNN accelerator like xDNN, but rather a tool for exploring the design space of DNN inference accelerators on FPGAs.
What is FINN?
=============
'FINN' is colloquially used to refer to two separate but highly related things:
* The FINN project, which includes tools for training quantized neural networks such as Brevitas, the FINN compiler, and the finn-hlslib Vivado HLS library of FPGA components for QNNs. An overview of the project can be taken from the following graphic and details can be seen on the project homepage.
.. image:: ../img/finn-flow.png
:height: 600px
:scale: 75%
:align: center
* The repository, this readthedocs website corresponds to. This is the FINN compiler, which is the centerpiece of the FINN project. The GitHub repositroy can be viewed using the link in the upper right corner.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
......
...@@ -80,9 +80,12 @@ ...@@ -80,9 +80,12 @@
<!-- Local TOC --> <!-- Local TOC -->
<div class="local-toc"><ul> <div class="local-toc"><ul>
<li><a class="reference internal" href="#">FINN</a></li> <li><a class="reference internal" href="#">FINN</a><ul>
<li><a class="reference internal" href="#what-is-finn">What is FINN?</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul> </ul>
</li>
</ul>
</div> </div>
...@@ -148,16 +151,39 @@ ...@@ -148,16 +151,39 @@
<div class="section" id="finn"> <div class="section" id="finn">
<h1>FINN<a class="headerlink" href="#finn" title="Permalink to this headline"></a></h1> <h1>FINN<a class="headerlink" href="#finn" title="Permalink to this headline"></a></h1>
<p>FINN is an experimental framework from Xilinx Research Labs to explore deep neural network inference on FPGAs. It specifically targets quantized neural networks, with emphasis on generating dataflow-style architectures customized for each network. It is not intended to be a generic DNN accelerator like xDNN, but rather a tool for exploring the design space of DNN inference accelerators on FPGAs.</p>
<div class="section" id="what-is-finn">
<h2>What is FINN?<a class="headerlink" href="#what-is-finn" title="Permalink to this headline"></a></h2>
<p>‘FINN’ is colloquially used to refer to two separate but highly related things:
* The FINN project, which includes tools for training quantized neural networks such as Brevitas, the FINN compiler, and the finn-hlslib Vivado HLS library of FPGA components for QNNs. An overview of the project can be taken from the following graphic and details can be seen on the project homepage.
.. image:: ../img/finn-flow.png</p>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">height</dt>
<dd class="field-odd"><p>600px</p>
</dd>
<dt class="field-even">scale</dt>
<dd class="field-even"><p>75%</p>
</dd>
<dt class="field-odd">align</dt>
<dd class="field-odd"><p>center</p>
</dd>
</dl>
</div></blockquote>
<ul class="simple">
<li><p>The repository, this readthedocs website corresponds to. This is the FINN compiler, which is the centerpiece of the FINN project. The GitHub repositroy can be viewed using the link in the upper right corner.</p></li>
</ul>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
</div> </div>
</div> </div>
<div class="section" id="indices-and-tables"> <div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1> <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h2>
<ul class="simple"> <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="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="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> <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul> </ul>
</div>
</div> </div>
......
This diff is collapsed.
...@@ -3,8 +3,20 @@ ...@@ -3,8 +3,20 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
****
FINN FINN
================================ ****
FINN is an experimental framework from Xilinx Research Labs to explore deep neural network inference on FPGAs. It specifically targets quantized neural networks, with emphasis on generating dataflow-style architectures customized for each network. It is not intended to be a generic DNN accelerator like xDNN, but rather a tool for exploring the design space of DNN inference accelerators on FPGAs.
What is FINN?
=============
'FINN' is colloquially used to refer to two separate but highly related things:
* The FINN project, which includes tools for training quantized neural networks such as Brevitas, the FINN compiler, and the finn-hlslib Vivado HLS library of FPGA components for QNNs. An overview of the project can be taken from the following graphic and details can be seen on the project homepage.
.. image:: ../img/finn-flow.png
:height: 600px
:scale: 75%
:align: center
* The repository, this readthedocs website corresponds to. This is the FINN compiler, which is the centerpiece of the FINN project. The GitHub repositroy can be viewed using the link in the upper right corner.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment