diff --git a/docs/finn/example_networks.rst b/docs/finn/example_networks.rst new file mode 100644 index 0000000000000000000000000000000000000000..cc94da135466998fd825225784dfa79c66c0394f --- /dev/null +++ b/docs/finn/example_networks.rst @@ -0,0 +1,27 @@ +.. _example_networks: + +*************** +Example Networks +*************** + +FINN uses [several pre-trained QNNs](https://github.com/maltanar/brevitas_cnv_lfc) that serve as examples and testcases. You can find a status summary below for each network. + +* TFC, SFC, LFC... are fully-connected networks trained on the MNIST dataset +* CNV is a convolutional network trained on the CIFAR-10 dataset +* w_a_ refers to the quantization used for the weights (w) and activations (a) in bits + +The rows in the table are different steps of the FINN end-to-end flow. +If a particular network is supported for a particular step in the current FINN +version, this is indicated by an x mark in the table. + + +| | Basic test | TFC-w1a1 | TFC-w1a2 | CNV-w1a1 | CNV-w1a2 | CNV-w2a2 | +|--------------------------- |------------ |---------- |---------- |---------- |---------- |---------- | +| Export/Import | x | x | x | x | | | +| Streamlining | x | x | x | | | | +| Convert to HLS layers | x | x | | | | | +| npysim | x | x | | | | | +| Stitched IPI design | x | x | | | | | +| rtlsim node-by-node | x | x | | | | | +| rtlsim stitched IP | x | x | | | | | +| Hardware test | x | x | | | | | diff --git a/docs/finn/index.rst b/docs/finn/index.rst index 00c0ad9f0dd10599ec75189cabdd83d7a28774c8..969b8afad5d259f8e3e3d49e95d52c93917a5e01 100644 --- a/docs/finn/index.rst +++ b/docs/finn/index.rst @@ -26,10 +26,8 @@ More FINN Resources =================== * `List of publications <https://github.com/Xilinx/finn/blob/dev/docs/publications.md>`_ - + * `Roadmap <https://github.com/Xilinx/finn/projects/1>`_ - -* `Status of example networks <https://github.com/Xilinx/finn/blob/dev/docs/example-networks.md>`_ .. toctree:: :maxdepth: 5 @@ -38,6 +36,7 @@ More FINN Resources getting_started tutorials end_to_end_flow + example_networks internals source_code/finn genindex