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

[Sphinx Documentation] Add note to every page to state that the website is...

[Sphinx Documentation] Add note to every page to state that the website is currently under construction
parent a4c39558
No related merge requests found
......@@ -4,6 +4,8 @@
Brevitas Export
***************
.. note:: **This website is currently under construction.**
.. image:: /img/brevitas-export.png
:scale: 70%
:align: center
......
......@@ -2,6 +2,8 @@
End-to-End Flow
***************
.. note:: **This website is currently under construction.**
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/end2end_example/finn-design-flow-example.svg
......
......@@ -2,6 +2,8 @@
Getting Started
***************
.. note:: **This website is currently under construction.**
How to use the FINN compiler
============================
The FINN compiler should not be thought of a single pushbutton tool that does everything for you, but rather as a collection of scripts/tools that will help you convert a QNN into a custom FPGA accelerator that performs high-performance inference. We do provide several examples of taking trained networks all the way down to FPGA bitfiles, but if you are trying to do this for custom networks you will have to write your own Python scripts that call the appropriate FINN Compiler functions that process your design correctly, or adding new functions as required.
......
......@@ -2,6 +2,8 @@
Internals
*********
.. note:: **This website is currently under construction.**
Intermediate Representation: FINN-ONNX
======================================
......
......@@ -4,7 +4,7 @@
Network Preparation
*******************
.. note:: **Here will be soon a detailed description of how the network preparation in FINN works.**
.. note:: **This website is currently under construction.**
.. image:: /img/nw-prep.png
:scale: 70%
......
......@@ -4,7 +4,7 @@
PYNQ Deployment
***************
.. note:: **On this page you can find soon more details about the PYNQ deployment in FINN.**
.. note:: **This website is currently under construction.**
.. image:: /img/pynq-deploy.png
:scale: 70%
......
......@@ -4,4 +4,6 @@
Tutorials
*********
.. note:: **This website is currently under construction.**
.. note:: **On this page a guide for the Jupyter notebooks in the FINN repo will be available shortly.** Please feel free to already take a look at the notebooks using this `link <https://github.com/Xilinx/finn/tree/dev/notebooks>`_.
......@@ -4,7 +4,7 @@
Functional Verification
***********************
.. note:: **Here will be soon a detailed description of the methods used in FINN to functionally verify a model.**
.. note:: **This website is currently under construction.**
.. image:: /img/verification.png
:scale: 70%
......
......@@ -4,7 +4,7 @@
Vivado HLS and Vivado IPI
*************************
.. note:: **Here will be soon a detailed description of how Vivado is used in FINN.**
.. note:: **This website is currently under construction.**
.. image:: /img/vivado-synth.png
:scale: 70%
......
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