From b045a114e7112fe77c86f5a912fba9553c800d0e Mon Sep 17 00:00:00 2001 From: Yaman Umuroglu <yamanu@xilinx.com> Date: Thu, 27 Feb 2020 15:24:24 +0000 Subject: [PATCH] [Doc] fix example nets rst errors, redirect old page --- docs/example-networks.md | 18 ++--------------- docs/finn/example_networks.rst | 35 +++++++++++++++++++++------------- 2 files changed, 24 insertions(+), 29 deletions(-) diff --git a/docs/example-networks.md b/docs/example-networks.md index e3cf51740..060836ff9 100644 --- a/docs/example-networks.md +++ b/docs/example-networks.md @@ -1,19 +1,5 @@ # Status for FINN 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. +This page has moved to: -* 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 - - -| | 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 | | | | | +https://finn-dev.readthedocs.io/en/latest/example_networks.html diff --git a/docs/finn/example_networks.rst b/docs/finn/example_networks.rst index cc94da135..1abe82d9f 100644 --- a/docs/finn/example_networks.rst +++ b/docs/finn/example_networks.rst @@ -4,24 +4,33 @@ 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. +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 +* 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 | | | | | ++-----------------------+------------+----------+----------+----------+----------+----------+ +| FINN step | 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 | | | | | ++-----------------------+------------+----------+----------+----------+----------+----------+ +| Stitched IP | x | x | | | | | ++-----------------------+------------+----------+----------+----------+----------+----------+ +| Hardware test | x | x | | | | | ++-----------------------+------------+----------+----------+----------+----------+----------+ +| npysim | x | x | | | | | ++-----------------------+------------+----------+----------+----------+----------+----------+ +| rtlsim node-by-node | x | x | | | | | ++-----------------------+------------+----------+----------+----------+----------+----------+ +| rtlsim stitched IP | x | x | | | | | ++-----------------------+------------+----------+----------+----------+----------+----------+ -- GitLab