Skip to content
Snippets Groups Projects
user avatar
Yaman Umuroglu authored
* [Build] initial commit for a build util fxn

* [Build] flesh out build_dataflow

* [Build] bugfixes+partitioning for dataflow build

* [Build] support from/to steps, add some verbosity

* [Build] use explicit strings for config enums

* [Deps] add clize and dataclasses-json

* [Build] add cmdline entry for building folder, mixin json to cfg

* [Build] cd into specified dir for build_dataflow

* [Infra] add new build_dataflow entrypoint to run_docker.sh

* [Build] let Python do exception handling in build_dataflow

* [Infra] add new run-docker.sh entrypoint for build_custom

* [Deps, Infra] update finn-base, set FINN_BUILD_DIR envvar

* [Test] fix manual /tmp usage in tests

* [Infra] avoid manual setting of build dir for now

breaks in IP stitching for some reason

* [Docs, Build] rename to build_dataflow + add some docs

* [GHA] fix missing env.var.

* [Build] allow specifying steps by name

* [Build] add logging support in build_dataflow

* [Zynq] use impl resources, add close_project

still looking for ways around Vivado randomly hanging and not exiting 
after synth finish

* [Build] make more outputs available from build_dataflow

* [Zynq] use vivado -batch for tcl call to synth

* [Deps] update pyverilator

* [Build] use abspath

* [Test] add test_build_dataflow_directory

* [Build] add build.py example

* [Docs] add docs about command line entry

* [Setup] include finn-base in install_requires

this is needed to build readthedocs properly
46653dc9
History

Fast, Scalable Quantized Neural Network Inference on FPGAs

drawing

Gitter ReadTheDocs

FINN is an experimental framework from Xilinx Research Labs to explore deep neural network inference on FPGAs. It specifically targets quantized neural networks, with emphasis on generating dataflow-style architectures customized for each network. The resulting FPGA accelerators can yield very high classification rates, or conversely be run with a slow clock for very low power consumption. The framework is fully open-source in order to give a higher degree of flexibility, and is intended to enable neural network research spanning several layers of the software/hardware abstraction stack.

For more general information about FINN, please visit the project page, check out the publications or some of the demos.

Getting Started

Please see the Getting Started page for more information on requirements, installation, and how to run FINN in different modes. Due to the complex nature of the dependencies of the project, we only support Docker-based deployment at this time.

What's New in FINN?

  • 2020-09-21: v0.4b (beta) is released. Read more on the release blog post.
  • 2020-05-08: v0.3b (beta) is released, with initial support for convolutions, parallel transformations, more flexible memory allocation for MVAUs, throughput testing and many other smaller improvements and bugfixes. Read more on the release blog post.
  • 2020-04-15: FINN v0.2.1b (beta): use fixed commit versions for dependency repos, otherwise identical to 0.2b
  • 2020-02-28: FINN v0.2b (beta) is released, which is a clean-slate reimplementation of the framework. Currently only fully-connected networks are supported for the end-to-end flow. Please see the release blog post for a summary of the key features.

Documentation

You can view the documentation on readthedocs or build them locally using python setup.py doc from inside the Docker container. Additionally, there is a series of Jupyter notebook tutorials, which we recommend running from inside Docker for a better experience.

Community

We have a gitter channel where you can ask questions. You can use the GitHub issue tracker to report bugs, but please don't file issues to ask questions as this is better handled in the gitter channel.

We also heartily welcome contributions to the project, please check out the contribution guidelines and the list of open issues. Don't hesitate to get in touch over Gitter to discuss your ideas.

Citation

The current implementation of the framework is based on the following publications. Please consider citing them if you find FINN useful.

@article{blott2018finn,
  title={FINN-R: An end-to-end deep-learning framework for fast exploration of quantized neural networks},
  author={Blott, Michaela and Preu{\ss}er, Thomas B and Fraser, Nicholas J and Gambardella, Giulio and O’brien, Kenneth and Umuroglu, Yaman and Leeser, Miriam and Vissers, Kees},
  journal={ACM Transactions on Reconfigurable Technology and Systems (TRETS)},
  volume={11},
  number={3},
  pages={1--23},
  year={2018},
  publisher={ACM New York, NY, USA}
}

@inproceedings{finn,
author = {Umuroglu, Yaman and Fraser, Nicholas J. and Gambardella, Giulio and Blott, Michaela and Leong, Philip and Jahre, Magnus and Vissers, Kees},
title = {FINN: A Framework for Fast, Scalable Binarized Neural Network Inference},
booktitle = {Proceedings of the 2017 ACM/SIGDA International Symposium on Field-Programmable Gate Arrays},
series = {FPGA '17},
year = {2017},
pages = {65--74},
publisher = {ACM}
}

Old version

We previously released an early-stage prototype of a toolflow that took in Caffe-HWGQ binarized network descriptions and produced dataflow architectures. You can find it in the v0.1 branch in this repository. Please be aware that this version is deprecated and unsupported, and the master branch does not share history with that branch so it should be treated as a separate repository for all purposes.