From b7da30f71cb43489bce28bbe19c20293601b7150 Mon Sep 17 00:00:00 2001
From: Yaman Umuroglu <yamanu@xilinx.com>
Date: Thu, 17 Dec 2020 18:54:24 +0100
Subject: [PATCH] [Docs] apidocs updates
---
docs/finn/example_networks.rst | 4 +-
.../finn.analysis.fpgadataflow.rst | 34 ++++++++
docs/finn/source_code/finn.analysis.rst | 9 ++
docs/finn/source_code/finn.core.rst | 8 ++
.../finn.custom_op.fpgadataflow.rst | 2 +-
.../source_code/finn.custom_op.general.rst | 62 ++++++++++++++
docs/finn/source_code/finn.custom_op.rst | 51 ++---------
.../finn.transformation.fpgadataflow.rst | 85 +++++++++++++++++++
docs/finn/source_code/finn.transformation.rst | 27 ++++++
.../finn.transformation.streamline.rst | 8 ++
docs/finn/source_code/finn.util.rst | 69 +++++++++++++++
11 files changed, 311 insertions(+), 48 deletions(-)
create mode 100644 docs/finn/source_code/finn.custom_op.general.rst
diff --git a/docs/finn/example_networks.rst b/docs/finn/example_networks.rst
index e76efe27c..3f1ae0d60 100644
--- a/docs/finn/example_networks.rst
+++ b/docs/finn/example_networks.rst
@@ -9,9 +9,9 @@ repository. This repo includes prebuilt bitfiles for various PYNQ and Alveo
platforms, as well as the scripts to rebuild these examples using the FINN
compiler.
-****************************
+
End-to-end Integration tests
-****************************
+============================
The FINN compiler uses `several pre-trained QNNs <https://github.com/Xilinx/brevitas/tree/master/brevitas_examples/bnn_pynq>`_
that serve as both examples and testcases.
diff --git a/docs/finn/source_code/finn.analysis.fpgadataflow.rst b/docs/finn/source_code/finn.analysis.fpgadataflow.rst
index 72f8fb811..b52e994ee 100644
--- a/docs/finn/source_code/finn.analysis.fpgadataflow.rst
+++ b/docs/finn/source_code/finn.analysis.fpgadataflow.rst
@@ -4,6 +4,32 @@ Analysis - fpgadataflow
Analysis Passes (fpgadataflow)
==============================
+finn.analysis.fpgadataflow.dataflow\_performance
+------------------------------------------------
+
+.. automodule:: finn.analysis.fpgadataflow.dataflow_performance
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+finn.analysis.fpgadataflow.exp\_cycles\_per\_layer
+---------------------------------------------------
+
+.. automodule:: finn.analysis.fpgadataflow.exp_cycles_per_layer
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+finn.analysis.fpgadataflow.floorplan\_params
+--------------------------------------------
+
+.. automodule:: finn.analysis.fpgadataflow.floorplan_params
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.analysis.fpgadataflow.hls\_synth\_res\_estimation
-------------------------------------------------------------
@@ -12,6 +38,14 @@ finn.analysis.fpgadataflow.hls\_synth\_res\_estimation
:undoc-members:
:show-inheritance:
+ finn.analysis.fpgadataflow.op\_and\_param\_counts
+ --------------------------------------------------
+
+ .. automodule:: finn.analysis.fpgadataflow.op_and_param_counts
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.analysis.fpgadataflow.post\_synth\_res
--------------------------------------------------
diff --git a/docs/finn/source_code/finn.analysis.rst b/docs/finn/source_code/finn.analysis.rst
index 61946f8fe..731215065 100644
--- a/docs/finn/source_code/finn.analysis.rst
+++ b/docs/finn/source_code/finn.analysis.rst
@@ -15,6 +15,15 @@ Submodules
Analysis Passes
===============
+finn.analysis.base
+-----------------------------
+
+.. automodule:: finn.analysis.base
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
finn.analysis.topology
-----------------------------
diff --git a/docs/finn/source_code/finn.core.rst b/docs/finn/source_code/finn.core.rst
index 3ac077c69..86afd5a10 100644
--- a/docs/finn/source_code/finn.core.rst
+++ b/docs/finn/source_code/finn.core.rst
@@ -5,6 +5,14 @@ Core
Modules
=======
+finn.core.data\_layout
+-------------------------
+
+.. automodule:: finn.core.data_layout
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.core.datatype
-------------------------
diff --git a/docs/finn/source_code/finn.custom_op.fpgadataflow.rst b/docs/finn/source_code/finn.custom_op.fpgadataflow.rst
index 5345fed59..7b4e7bfa0 100644
--- a/docs/finn/source_code/finn.custom_op.fpgadataflow.rst
+++ b/docs/finn/source_code/finn.custom_op.fpgadataflow.rst
@@ -1,5 +1,5 @@
************************
-Custom Op - FPGADataFlow
+Custom Op - fpgadataflow
************************
HLS Custom Op Nodes
diff --git a/docs/finn/source_code/finn.custom_op.general.rst b/docs/finn/source_code/finn.custom_op.general.rst
new file mode 100644
index 000000000..e86774a48
--- /dev/null
+++ b/docs/finn/source_code/finn.custom_op.general.rst
@@ -0,0 +1,62 @@
+************************
+Custom Op - General
+************************
+
+General Custom Ops
+===================
+
+finn.custom\_op.general.debugmarker
+-----------------------------------
+
+.. automodule:: finn.custom_op.general.debugmarker
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.custom\_op.general.im2col
+------------------------------
+
+.. automodule:: finn.custom_op.general.im2col
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.custom\_op.general.maxpoolnhwc
+------------------------------------
+
+.. automodule:: finn.custom_op.general.maxpoolnhwc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.custom\_op.general.multithreshold
+---------------------------------------
+
+.. automodule:: finn.custom_op.general.multithreshold
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.custom\_op.general.quantavgpool2d
+--------------------------------------
+
+.. automodule:: finn.custom_op.general.quantavgpool2d
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.custom\_op.general.streamingdataflowpartition
+---------------------------------------------------
+
+.. automodule:: finn.custom_op.general.streamingdataflowpartition
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.custom\_op.general.xnorpopcount
+-------------------------------------
+
+.. automodule:: finn.custom_op.general.xnorpopcount
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/finn/source_code/finn.custom_op.rst b/docs/finn/source_code/finn.custom_op.rst
index 8c43ddb42..1ee3e1dce 100644
--- a/docs/finn/source_code/finn.custom_op.rst
+++ b/docs/finn/source_code/finn.custom_op.rst
@@ -9,6 +9,7 @@ Submodules
:maxdepth: 2
finn.custom_op.fpgadataflow
+ finn.custom_op.general
Custom Op Nodes
===============
@@ -16,55 +17,15 @@ Custom Op Nodes
Base Class
----------
-.. automodule:: finn.custom_op
- :members:
- :undoc-members:
- :show-inheritance:
-
-finn.custom\_op.im2col
------------------------------
-
-.. automodule:: finn.custom_op.general.im2col
- :members:
- :undoc-members:
- :show-inheritance:
-
-finn.custom\_op.maxpoolnhwc
-----------------------------------
-
-.. automodule:: finn.custom_op.general.maxpoolnhwc
- :members:
- :undoc-members:
- :show-inheritance:
-
-finn.custom\_op.multithreshold
--------------------------------------
-
-.. automodule:: finn.custom_op.general.multithreshold
+.. automodule:: finn.custom_op.base
:members:
:undoc-members:
:show-inheritance:
finn.custom\_op.registry
--------------------------------
+-------------------------
.. automodule:: finn.custom_op.registry
- :members:
- :undoc-members:
- :show-inheritance:
-
-finn.custom\_op.streamingdataflowpartition
--------------------------------------------------
-
-.. automodule:: finn.custom_op.general.streamingdataflowpartition
- :members:
- :undoc-members:
- :show-inheritance:
-
-finn.custom\_op.xnorpopcount
------------------------------------
-
-.. automodule:: finn.custom_op.general.xnorpopcount
- :members:
- :undoc-members:
- :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.rst
index c2c184ef1..42bc7fb53 100644
--- a/docs/finn/source_code/finn.transformation.fpgadataflow.rst
+++ b/docs/finn/source_code/finn.transformation.fpgadataflow.rst
@@ -5,6 +5,15 @@ Transformation - fpgadataflow
Transformations (fpgadataflow)
==============================
+finn.transformation.fpgadataflow.annotate\_cycles
+-----------------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.annotate_cycles
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
finn.transformation.fpgadataflow.annotate\_resources
-----------------------------------------------------------
@@ -53,6 +62,15 @@ finn.transformation.fpgadataflow.create\_stitched\_ip
:undoc-members:
:show-inheritance:
+finn.transformation.fpgadataflow.floorplan
+----------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.floorplan
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
finn.transformation.fpgadataflow.hlssynth\_ip
----------------------------------------------------
@@ -77,6 +95,15 @@ finn.transformation.fpgadataflow.insert\_fifo
:undoc-members:
:show-inheritance:
+finn.transformation.fpgadataflow.insert\_iodma
+----------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.insert_iodma
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
finn.transformation.fpgadataflow.insert\_tlastmarker
-----------------------------------------------------------
@@ -101,6 +128,24 @@ finn.transformation.fpgadataflow.make\_pynq\_driver
:undoc-members:
:show-inheritance:
+finn.transformation.fpgadataflow.make\_zynq\_proj
+----------------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.make_zynq_proj
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+finn.transformation.fpgadataflow.minimize\_accumulator\_width
+--------------------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.minimize_accumulator_width
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
finn.transformation.fpgadataflow.prepare\_cppsim
-------------------------------------------------------
@@ -141,10 +186,50 @@ finn.transformation.fpgadataflow.set\_exec\_mode
:undoc-members:
:show-inheritance:
+finn.transformation.fpgadataflow.set\_fifo\_depths
+-------------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.set_fifo_depths
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.transformation.fpgadataflow.set\_folding
+-------------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.set_folding
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.transformation.fpgadataflow.synth\_ooc
+-------------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.synth_ooc
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.transformation.fpgadataflow.template\_driver
+-------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.template_driver
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.transformation.fpgadataflow.templates
-------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.templates
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.transformation.fpgadataflow.vitis\_build
+-------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.vitis_build
:members:
:undoc-members:
:show-inheritance:
diff --git a/docs/finn/source_code/finn.transformation.rst b/docs/finn/source_code/finn.transformation.rst
index 4378cbf8e..aeb0d7614 100644
--- a/docs/finn/source_code/finn.transformation.rst
+++ b/docs/finn/source_code/finn.transformation.rst
@@ -40,6 +40,15 @@ finn.transformation.bipolar\_to\_xnor
:undoc-members:
:show-inheritance:
+finn.transformation.change\_datalayout
+--------------------------------------------
+
+.. automodule:: finn.transformation.change_datalayout
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
finn.transformation.double\_to\_single\_float
----------------------------------------------------
@@ -64,6 +73,14 @@ finn.transformation.general
:undoc-members:
:show-inheritance:
+finn.transformation.infer\_data\_layouts
+-------------------------------------------
+
+.. automodule:: finn.transformation.infer_data_layouts
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.transformation.infer\_datatypes
-------------------------------------------
@@ -96,6 +113,16 @@ finn.transformation.lower\_convs\_to\_matmul
:undoc-members:
:show-inheritance:
+
+finn.transformation.merge\_onnx\_models
+----------------------------------------
+
+.. automodule:: finn.transformation.merge_onnx_models
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
finn.transformation.move\_reshape
----------------------------------------
diff --git a/docs/finn/source_code/finn.transformation.streamline.rst b/docs/finn/source_code/finn.transformation.streamline.rst
index 017622f04..f43d6d123 100644
--- a/docs/finn/source_code/finn.transformation.streamline.rst
+++ b/docs/finn/source_code/finn.transformation.streamline.rst
@@ -26,6 +26,14 @@ finn.transformation.streamline.collapse\_repeated
:undoc-members:
:show-inheritance:
+finn.transformation.streamline.remove
+-------------------------------------
+
+.. automodule:: finn.transformation.streamline.remove
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.transformation.streamline.reorder
---------------------------------------------
diff --git a/docs/finn/source_code/finn.util.rst b/docs/finn/source_code/finn.util.rst
index d5bbd6235..82e4bf326 100644
--- a/docs/finn/source_code/finn.util.rst
+++ b/docs/finn/source_code/finn.util.rst
@@ -13,6 +13,24 @@ finn.util.basic
:undoc-members:
:show-inheritance:
+finn.util.config
+----------------
+
+.. automodule:: finn.util.config
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.util.create
+----------------
+
+.. automodule:: finn.util.create
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+
finn.util.data\_packing
------------------------------
@@ -29,6 +47,23 @@ finn.util.fpgadataflow
:undoc-members:
:show-inheritance:
+finn.util.gdrive
+-----------------------------
+
+.. automodule:: finn.util.gdrive
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.util.imagenet
+-----------------------------
+
+.. automodule:: finn.util.imagenet
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
finn.util.onnx
---------------------
@@ -37,6 +72,24 @@ finn.util.onnx
:undoc-members:
:show-inheritance:
+finn.util.pytorch
+------------------
+
+.. automodule:: finn.util.pytorch
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+finn.util.pyverilator
+---------------------
+
+.. automodule:: finn.util.pyverilator
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
finn.util.test
---------------------
@@ -45,6 +98,14 @@ finn.util.test
:undoc-members:
:show-inheritance:
+finn.util.vcd
+------------------------------
+
+.. automodule:: finn.util.vcd
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.util.visualization
------------------------------
@@ -52,3 +113,11 @@ finn.util.visualization
:members:
:undoc-members:
:show-inheritance:
+
+finn.util.vivado
+------------------------------
+
+.. automodule:: finn.util.vivado
+ :members:
+ :undoc-members:
+ :show-inheritance:
--
GitLab