From 7f19a2f05f91a8b76ead084856e4881bc694745c Mon Sep 17 00:00:00 2001
From: auphelia <jakobapk@web.de>
Date: Fri, 8 May 2020 11:15:13 +0100
Subject: [PATCH] [Sphinx documentation] Update autogenerated rst files for
source code
---
.../finn.analysis.fpgadataflow.rst | 15 ++-
docs/finn/source_code/finn.analysis.rst | 9 +-
docs/finn/source_code/finn.core.rst | 22 +++--
.../finn.custom_op.fpgadataflow.rst | 21 +++--
docs/finn/source_code/finn.custom_op.rst | 15 ++-
docs/finn/source_code/finn.rst | 1 -
.../finn.transformation.fpgadataflow.rst | 92 ++++++++++++-------
docs/finn/source_code/finn.transformation.rst | 39 ++++++--
.../finn.transformation.streamline.rst | 11 +--
docs/finn/source_code/finn.util.rst | 17 +++-
docs/finn/source_code/modules.rst | 7 --
11 files changed, 155 insertions(+), 94 deletions(-)
diff --git a/docs/finn/source_code/finn.analysis.fpgadataflow.rst b/docs/finn/source_code/finn.analysis.fpgadataflow.rst
index 9c1b0dd99..72f8fb811 100644
--- a/docs/finn/source_code/finn.analysis.fpgadataflow.rst
+++ b/docs/finn/source_code/finn.analysis.fpgadataflow.rst
@@ -1,22 +1,29 @@
-Analysis - fpgadataflow
+Analysis - fpgadataflow
***********************
Analysis Passes (fpgadataflow)
==============================
finn.analysis.fpgadataflow.hls\_synth\_res\_estimation
-------------------------------------------------------
+-------------------------------------------------------------
.. automodule:: finn.analysis.fpgadataflow.hls_synth_res_estimation
:members:
:undoc-members:
:show-inheritance:
+finn.analysis.fpgadataflow.post\_synth\_res
+--------------------------------------------------
+
+.. automodule:: finn.analysis.fpgadataflow.post_synth_res
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.analysis.fpgadataflow.res\_estimation
-------------------------------------------
+-------------------------------------------------
.. automodule:: finn.analysis.fpgadataflow.res_estimation
:members:
:undoc-members:
:show-inheritance:
-
diff --git a/docs/finn/source_code/finn.analysis.rst b/docs/finn/source_code/finn.analysis.rst
index 9ce1b9999..61946f8fe 100644
--- a/docs/finn/source_code/finn.analysis.rst
+++ b/docs/finn/source_code/finn.analysis.rst
@@ -1,5 +1,5 @@
********
-Analysis
+Analysis
********
If you want to know more details about analysis passes, please take a look at section ":ref:`analysis_pass`" in chapter *Internals*.
@@ -8,7 +8,7 @@ Submodules
==========
.. toctree::
- :maxdepth: 2
+ :maxdepth: 2
finn.analysis.fpgadataflow
@@ -16,7 +16,7 @@ Analysis Passes
===============
finn.analysis.topology
-----------------------
+-----------------------------
.. automodule:: finn.analysis.topology
:members:
@@ -24,10 +24,9 @@ finn.analysis.topology
:show-inheritance:
finn.analysis.verify\_custom\_nodes
------------------------------------
+------------------------------------------
.. automodule:: finn.analysis.verify_custom_nodes
:members:
:undoc-members:
:show-inheritance:
-
diff --git a/docs/finn/source_code/finn.core.rst b/docs/finn/source_code/finn.core.rst
index f9d59fc0f..3ac077c69 100644
--- a/docs/finn/source_code/finn.core.rst
+++ b/docs/finn/source_code/finn.core.rst
@@ -6,7 +6,7 @@ Modules
=======
finn.core.datatype
-------------------
+-------------------------
.. automodule:: finn.core.datatype
:members:
@@ -14,7 +14,7 @@ finn.core.datatype
:show-inheritance:
finn.core.execute\_custom\_node
--------------------------------
+--------------------------------------
.. automodule:: finn.core.execute_custom_node
:members:
@@ -22,9 +22,7 @@ finn.core.execute\_custom\_node
:show-inheritance:
finn.core.modelwrapper
-----------------------
-
-If you want to have more details about the module ModelWrapper, please have a look at section ":ref:`modelwrapper`" in chapter *Internals*.
+-----------------------------
.. automodule:: finn.core.modelwrapper
:members:
@@ -32,7 +30,7 @@ If you want to have more details about the module ModelWrapper, please have a lo
:show-inheritance:
finn.core.onnx\_exec
---------------------
+---------------------------
.. automodule:: finn.core.onnx_exec
:members:
@@ -40,7 +38,7 @@ finn.core.onnx\_exec
:show-inheritance:
finn.core.remote\_exec
-----------------------
+-----------------------------
.. automodule:: finn.core.remote_exec
:members:
@@ -48,9 +46,17 @@ finn.core.remote\_exec
:show-inheritance:
finn.core.rtlsim\_exec
-----------------------
+-----------------------------
.. automodule:: finn.core.rtlsim_exec
:members:
:undoc-members:
:show-inheritance:
+
+finn.core.throughput\_test
+---------------------------------
+
+.. automodule:: finn.core.throughput_test
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/finn/source_code/finn.custom_op.fpgadataflow.rst b/docs/finn/source_code/finn.custom_op.fpgadataflow.rst
index 7e9ebcbec..5345fed59 100644
--- a/docs/finn/source_code/finn.custom_op.fpgadataflow.rst
+++ b/docs/finn/source_code/finn.custom_op.fpgadataflow.rst
@@ -14,7 +14,7 @@ Base Class
:show-inheritance:
finn.custom\_op.fpgadataflow.convolutioninputgenerator
-------------------------------------------------------
+-------------------------------------------------------------
.. automodule:: finn.custom_op.fpgadataflow.convolutioninputgenerator
:members:
@@ -22,7 +22,7 @@ finn.custom\_op.fpgadataflow.convolutioninputgenerator
:show-inheritance:
finn.custom\_op.fpgadataflow.streamingdatawidthconverter\_batch
----------------------------------------------------------------
+----------------------------------------------------------------------
.. automodule:: finn.custom_op.fpgadataflow.streamingdatawidthconverter_batch
:members:
@@ -30,15 +30,23 @@ finn.custom\_op.fpgadataflow.streamingdatawidthconverter\_batch
:show-inheritance:
finn.custom\_op.fpgadataflow.streamingfclayer\_batch
-----------------------------------------------------
+-----------------------------------------------------------
.. automodule:: finn.custom_op.fpgadataflow.streamingfclayer_batch
:members:
:undoc-members:
:show-inheritance:
+finn.custom\_op.fpgadataflow.streamingfifo
+-------------------------------------------------
+
+.. automodule:: finn.custom_op.fpgadataflow.streamingfifo
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.custom\_op.fpgadataflow.streamingmaxpool\_batch
-----------------------------------------------------
+-----------------------------------------------------------
.. automodule:: finn.custom_op.fpgadataflow.streamingmaxpool_batch
:members:
@@ -46,7 +54,7 @@ finn.custom\_op.fpgadataflow.streamingmaxpool\_batch
:show-inheritance:
finn.custom\_op.fpgadataflow.templates
---------------------------------------
+---------------------------------------------
.. automodule:: finn.custom_op.fpgadataflow.templates
:members:
@@ -54,10 +62,9 @@ finn.custom\_op.fpgadataflow.templates
:show-inheritance:
finn.custom\_op.fpgadataflow.tlastmarker
-----------------------------------------
+-----------------------------------------------
.. automodule:: finn.custom_op.fpgadataflow.tlastmarker
: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 cb436b1c1..72dd4beb9 100644
--- a/docs/finn/source_code/finn.custom_op.rst
+++ b/docs/finn/source_code/finn.custom_op.rst
@@ -21,9 +21,8 @@ Base Class
:undoc-members:
:show-inheritance:
-
finn.custom\_op.im2col
-----------------------
+-----------------------------
.. automodule:: finn.custom_op.im2col
:members:
@@ -31,7 +30,7 @@ finn.custom\_op.im2col
:show-inheritance:
finn.custom\_op.maxpoolnhwc
----------------------------
+----------------------------------
.. automodule:: finn.custom_op.maxpoolnhwc
:members:
@@ -39,7 +38,7 @@ finn.custom\_op.maxpoolnhwc
:show-inheritance:
finn.custom\_op.multithreshold
-------------------------------
+-------------------------------------
.. automodule:: finn.custom_op.multithreshold
:members:
@@ -47,7 +46,7 @@ finn.custom\_op.multithreshold
:show-inheritance:
finn.custom\_op.registry
-------------------------
+-------------------------------
.. automodule:: finn.custom_op.registry
:members:
@@ -55,7 +54,7 @@ finn.custom\_op.registry
:show-inheritance:
finn.custom\_op.streamingdataflowpartition
-------------------------------------------
+-------------------------------------------------
.. automodule:: finn.custom_op.streamingdataflowpartition
:members:
@@ -63,11 +62,9 @@ finn.custom\_op.streamingdataflowpartition
:show-inheritance:
finn.custom\_op.xnorpopcount
-----------------------------
+-----------------------------------
.. automodule:: finn.custom_op.xnorpopcount
:members:
:undoc-members:
:show-inheritance:
-
-
diff --git a/docs/finn/source_code/finn.rst b/docs/finn/source_code/finn.rst
index 6f6b591e1..1197c50a0 100644
--- a/docs/finn/source_code/finn.rst
+++ b/docs/finn/source_code/finn.rst
@@ -14,4 +14,3 @@ Modules
finn.custom_op
finn.transformation
finn.util
-
diff --git a/docs/finn/source_code/finn.transformation.fpgadataflow.rst b/docs/finn/source_code/finn.transformation.fpgadataflow.rst
index 4f0fb3e0b..cd6e44367 100644
--- a/docs/finn/source_code/finn.transformation.fpgadataflow.rst
+++ b/docs/finn/source_code/finn.transformation.fpgadataflow.rst
@@ -5,40 +5,24 @@ Transformation - fpgadataflow
Transformations (fpgadataflow)
==============================
-finn.transformation.fpgadataflow.cleanup
-----------------------------------------
+finn.transformation.fpgadataflow.annotate\_resources
+-----------------------------------------------------------
-.. automodule:: finn.transformation.fpgadataflow.cleanup
+.. automodule:: finn.transformation.fpgadataflow.annotate_resources
:members:
:undoc-members:
:show-inheritance:
-finn.transformation.fpgadataflow.prepare\_ip
+finn.transformation.fpgadataflow.cleanup
-----------------------------------------------
-.. automodule:: finn.transformation.fpgadataflow.prepare_ip
- :members:
- :undoc-members:
- :show-inheritance:
-
-finn.transformation.fpgadataflow.create\_stitched\_ip
---------------------------------------------------
-
-.. automodule:: finn.transformation.fpgadataflow.create_stitched_ip
- :members:
- :undoc-members:
- :show-inheritance:
-
-finn.transformation.fpgadataflow.prepare\_cppsim
-------------------------------------------------
-
-.. automodule:: finn.transformation.fpgadataflow.prepare_cppsim
+.. automodule:: finn.transformation.fpgadataflow.cleanup
:members:
:undoc-members:
:show-inheritance:
finn.transformation.fpgadataflow.compile\_cppsim
-----------------------------------------
+-------------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.compile_cppsim
:members:
@@ -46,7 +30,7 @@ finn.transformation.fpgadataflow.compile\_cppsim
:show-inheritance:
finn.transformation.fpgadataflow.convert\_to\_hls\_layers
----------------------------------------------------------
+----------------------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.convert_to_hls_layers
:members:
@@ -54,15 +38,23 @@ finn.transformation.fpgadataflow.convert\_to\_hls\_layers
:show-inheritance:
finn.transformation.fpgadataflow.create\_dataflow\_partition
-------------------------------------------------------------
+-------------------------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.create_dataflow_partition
:members:
:undoc-members:
:show-inheritance:
+finn.transformation.fpgadataflow.create\_stitched\_ip
+------------------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.create_stitched_ip
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.transformation.fpgadataflow.hlssynth\_ip
-------------------------------------------------
+----------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.hlssynth_ip
:members:
@@ -70,23 +62,31 @@ finn.transformation.fpgadataflow.hlssynth\_ip
:show-inheritance:
finn.transformation.fpgadataflow.insert\_dwc
---------------------------------------------
+---------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.insert_dwc
:members:
:undoc-members:
:show-inheritance:
-finn.transformation.fpgadataflow.insert\_tlastmarker
+finn.transformation.fpgadataflow.insert\_fifo
----------------------------------------------------
+.. automodule:: finn.transformation.fpgadataflow.insert_fifo
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.transformation.fpgadataflow.insert\_tlastmarker
+-----------------------------------------------------------
+
.. automodule:: finn.transformation.fpgadataflow.insert_tlastmarker
:members:
:undoc-members:
:show-inheritance:
finn.transformation.fpgadataflow.make\_deployment
--------------------------------------------------
+--------------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.make_deployment
:members:
@@ -94,7 +94,7 @@ finn.transformation.fpgadataflow.make\_deployment
:show-inheritance:
finn.transformation.fpgadataflow.make\_pynq\_driver
----------------------------------------------------
+----------------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.make_pynq_driver
:members:
@@ -102,15 +102,39 @@ finn.transformation.fpgadataflow.make\_pynq\_driver
:show-inheritance:
finn.transformation.fpgadataflow.make\_pynq\_proj
--------------------------------------------------
+--------------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.make_pynq_proj
:members:
:undoc-members:
:show-inheritance:
+finn.transformation.fpgadataflow.prepare\_cppsim
+-------------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.prepare_cppsim
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.transformation.fpgadataflow.prepare\_ip
+---------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.prepare_ip
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+finn.transformation.fpgadataflow.prepare\_rtlsim
+-------------------------------------------------------
+
+.. automodule:: finn.transformation.fpgadataflow.prepare_rtlsim
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.transformation.fpgadataflow.replace\_verilog\_relpaths
------------------------------------------------------------
+------------------------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.replace_verilog_relpaths
:members:
@@ -118,7 +142,7 @@ finn.transformation.fpgadataflow.replace\_verilog\_relpaths
:show-inheritance:
finn.transformation.fpgadataflow.set\_exec\_mode
-------------------------------------------------
+-------------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.set_exec_mode
:members:
@@ -126,7 +150,7 @@ finn.transformation.fpgadataflow.set\_exec\_mode
:show-inheritance:
finn.transformation.fpgadataflow.synth\_pynq\_proj
---------------------------------------------------
+---------------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.synth_pynq_proj
:members:
@@ -134,7 +158,7 @@ finn.transformation.fpgadataflow.synth\_pynq\_proj
:show-inheritance:
finn.transformation.fpgadataflow.templates
-------------------------------------------
+-------------------------------------------------
.. automodule:: finn.transformation.fpgadataflow.templates
:members:
diff --git a/docs/finn/source_code/finn.transformation.rst b/docs/finn/source_code/finn.transformation.rst
index 480c80302..4378cbf8e 100644
--- a/docs/finn/source_code/finn.transformation.rst
+++ b/docs/finn/source_code/finn.transformation.rst
@@ -16,8 +16,16 @@ Submodules
Transformation Passes
=====================
+Base Class
+----------
+
+.. automodule:: finn.transformation
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.transformation.batchnorm\_to\_affine
------------------------------------------
+------------------------------------------------
.. automodule:: finn.transformation.batchnorm_to_affine
:members:
@@ -25,7 +33,7 @@ finn.transformation.batchnorm\_to\_affine
:show-inheritance:
finn.transformation.bipolar\_to\_xnor
--------------------------------------
+--------------------------------------------
.. automodule:: finn.transformation.bipolar_to_xnor
:members:
@@ -33,7 +41,7 @@ finn.transformation.bipolar\_to\_xnor
:show-inheritance:
finn.transformation.double\_to\_single\_float
----------------------------------------------
+----------------------------------------------------
.. automodule:: finn.transformation.double_to_single_float
:members:
@@ -41,7 +49,7 @@ finn.transformation.double\_to\_single\_float
:show-inheritance:
finn.transformation.fold\_constants
------------------------------------
+------------------------------------------
.. automodule:: finn.transformation.fold_constants
:members:
@@ -49,7 +57,7 @@ finn.transformation.fold\_constants
:show-inheritance:
finn.transformation.general
----------------------------
+----------------------------------
.. automodule:: finn.transformation.general
:members:
@@ -57,7 +65,7 @@ finn.transformation.general
:show-inheritance:
finn.transformation.infer\_datatypes
-------------------------------------
+-------------------------------------------
.. automodule:: finn.transformation.infer_datatypes
:members:
@@ -65,18 +73,33 @@ finn.transformation.infer\_datatypes
:show-inheritance:
finn.transformation.infer\_shapes
----------------------------------
+----------------------------------------
.. automodule:: finn.transformation.infer_shapes
:members:
:undoc-members:
:show-inheritance:
+finn.transformation.insert\_topk
+---------------------------------------
+
+.. automodule:: finn.transformation.insert_topk
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
finn.transformation.lower\_convs\_to\_matmul
---------------------------------------------
+---------------------------------------------------
.. automodule:: finn.transformation.lower_convs_to_matmul
:members:
:undoc-members:
:show-inheritance:
+finn.transformation.move\_reshape
+----------------------------------------
+
+.. automodule:: finn.transformation.move_reshape
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/finn/source_code/finn.transformation.streamline.rst b/docs/finn/source_code/finn.transformation.streamline.rst
index 56d7f8272..017622f04 100644
--- a/docs/finn/source_code/finn.transformation.streamline.rst
+++ b/docs/finn/source_code/finn.transformation.streamline.rst
@@ -10,9 +10,8 @@ Transformation (Streamline)
:undoc-members:
:show-inheritance:
-
finn.transformation.streamline.absorb
--------------------------------------
+--------------------------------------------
.. automodule:: finn.transformation.streamline.absorb
:members:
@@ -20,7 +19,7 @@ finn.transformation.streamline.absorb
:show-inheritance:
finn.transformation.streamline.collapse\_repeated
--------------------------------------------------
+--------------------------------------------------------
.. automodule:: finn.transformation.streamline.collapse_repeated
:members:
@@ -28,7 +27,7 @@ finn.transformation.streamline.collapse\_repeated
:show-inheritance:
finn.transformation.streamline.reorder
---------------------------------------
+---------------------------------------------
.. automodule:: finn.transformation.streamline.reorder
:members:
@@ -36,7 +35,7 @@ finn.transformation.streamline.reorder
:show-inheritance:
finn.transformation.streamline.round\_thresholds
-------------------------------------------------
+-------------------------------------------------------
.. automodule:: finn.transformation.streamline.round_thresholds
:members:
@@ -44,7 +43,7 @@ finn.transformation.streamline.round\_thresholds
:show-inheritance:
finn.transformation.streamline.sign\_to\_thres
-----------------------------------------------
+-----------------------------------------------------
.. automodule:: finn.transformation.streamline.sign_to_thres
:members:
diff --git a/docs/finn/source_code/finn.util.rst b/docs/finn/source_code/finn.util.rst
index 7bcfde705..d5bbd6235 100644
--- a/docs/finn/source_code/finn.util.rst
+++ b/docs/finn/source_code/finn.util.rst
@@ -6,7 +6,7 @@ Utility Modules
===============
finn.util.basic
----------------
+----------------------
.. automodule:: finn.util.basic
:members:
@@ -14,7 +14,7 @@ finn.util.basic
:show-inheritance:
finn.util.data\_packing
------------------------
+------------------------------
.. automodule:: finn.util.data_packing
:members:
@@ -22,7 +22,7 @@ finn.util.data\_packing
:show-inheritance:
finn.util.fpgadataflow
-----------------------
+-----------------------------
.. automodule:: finn.util.fpgadataflow
:members:
@@ -30,7 +30,7 @@ finn.util.fpgadataflow
:show-inheritance:
finn.util.onnx
---------------
+---------------------
.. automodule:: finn.util.onnx
:members:
@@ -38,10 +38,17 @@ finn.util.onnx
:show-inheritance:
finn.util.test
---------------
+---------------------
.. automodule:: finn.util.test
:members:
:undoc-members:
:show-inheritance:
+finn.util.visualization
+------------------------------
+
+.. automodule:: finn.util.visualization
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/finn/source_code/modules.rst b/docs/finn/source_code/modules.rst
index dada6936c..e69de29bb 100644
--- a/docs/finn/source_code/modules.rst
+++ b/docs/finn/source_code/modules.rst
@@ -1,7 +0,0 @@
-finn
-====
-
-.. toctree::
- :maxdepth: 4
-
- finn
--
GitLab