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

[Sphinx Documentation] Update tutorials chapter

parent 3acb247b
No related branches found
No related tags found
No related merge requests found
......@@ -6,56 +6,47 @@ Tutorials
.. note:: **This website is currently under construction.**
FINN provides several Jupyter notebooks that can help to get familiar with the basics, the internals and the end-to-end flow in FINN. All Jupyter notebooks can be found in the repo in the `notebook folder <https://github.com/Xilinx/finn/tree/dev/notebooks>`_.
FINN provides several Jupyter notebooks that can help to get familiar with the basics, the internals and the end-to-end flow in FINN. All Jupyter notebooks can be found in the repo in the `notebook folder <https://github.com/Xilinx/finn/tree/master/notebooks>`_.
Basics
======
The notebooks in this folder should give a basic insight into FINN, how to get started and the basic concepts.
* `0_getting_started <https://github.com/Xilinx/finn/blob/master/notebooks/basics/0_getting_started.ipynb>`_
* This notebook corresponds to the chapter :ref:`getting_started` and gives an overview how to start working with FINN.
* `1_how_to_work_with_onnx <https://github.com/Xilinx/finn/blob/master/notebooks/basics/1_how_to_work_with_onnx.ipynb>`_
* 0_how_to_work_with_onnx
* This notebook can help you to learn how to create and manipulate a simple ONNX model, also by using FINN
* `2_modelwrapper <https://github.com/Xilinx/finn/blob/master/notebooks/basics/2_modelwrapper.ipynb>`_
* This notebook corresponds to the section :ref:`modelwrapper` in the chapter about internals.
* `3_brevitas_network_import <https://github.com/Xilinx/finn/blob/master/notebooks/basics/3_brevitas_network_import.ipynb>`_
* 1_brevitas_network_import
* This notebook shows how to import a brevitas network and prepare it for the FINN flow.
Internals
=========
Advanced
========
The notebooks in this folder are more developer oriented. They should help you to get familiar with the principles in FINN and how to add new content regarding these concepts.
* `0_custom_analysis_pass <https://github.com/Xilinx/finn/blob/master/notebooks/internals/0_custom_analysis_pass.ipynb>`_
* 0_custom_analysis_pass
* This notebook explains what an analysis pass is and how to write one for FINN.
* `1_custom_transformation_pass <https://github.com/Xilinx/finn/blob/master/notebooks/internals/1_custom_transformation_pass.ipynb>`_
* 1_custom_transformation_pass
* This notebook explains what a transformation pass is and how to write one for FINN.
* `2_custom_op <https://github.com/Xilinx/finn/blob/master/notebooks/internals/2_custom_op.ipynb>`_
End-to-End Flow
===============
* This notebooks explains what a custom operation/node is and how to create one for FINN.
This notebook shows the FINN end-to-end flow step by step using an example of a simple, binarized, fully-connected network trained on the MNIST data set. Starting with the brevitas export and taking this particular network all the way down to hardware by using a specific sequence of transformations.
* `3_verify_hls_custom_op <https://github.com/Xilinx/finn/blob/master/notebooks/internals/3_verify_hls_custom_op.ipynb>`_
* cnv_end2end_example
* This notebook shows the functional verification flow for hls custom operations/nodes.
* This notebook takes a simple convolutional model step-by-step from a trained Brevitas net to a running FPGA bitfile.
End-to-End Flow
===============
* tfc_end2end_example
This notebook shows the FINN end-to-end flow step by step using an example of a simple, binarized, fully-connected network trained on the MNIST data set. Starting with the brevitas export and taking this particular network all the way down to hardware by using a specific sequence of transformations.
* This notebook takes a simple fully-connected model step-by-step from a trained Brevitas net to a running FPGA bitfile.
* tfc_end2end_verification
* `tfc_end2end_example <https://github.com/Xilinx/finn/blob/master/notebooks/end2end_example/tfc_end2end_example.ipynb>`_
* This notebook takes the model step-by-step from a trained Brevitas net to a running FPGA bitfile.
* `tfc_end2end_verification <https://github.com/Xilinx/finn/blob/master/notebooks/end2end_example/tfc_end2end_verification.ipynb>`_
* This notebook runs parellel to the tfc_end2end_example notebook above, and shows how the output of each step can be verified.
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