finn-plus-driver

Runtime driver for FPGA accelerators generated by finn-plus and deployed to ZYNQ/PYNQ boards.

This package contains everything needed to run a FINN-generated accelerator and nothing of the compiler itself. It is installed on the board, while the accelerator-specific artifacts (bitfile, settings.json, runtime weights) are produced by the finn-plus build flow and copied to the board separately.

Installation

On a PYNQ board, inside the PYNQ virtual environment:

sudo pip install finn-plus-driver

pynq itself is not declared as a dependency: it is part of the board image.

To install the version matching a repository checkout (e.g. in CI):

sudo pip install ./driver

Usage

The driver is usually invoked through its CLI, which instantiates the driver class named in settings.json and calls one of its member functions:

finn-plus-driver -b bitfile/finn-accel.bit -s driver/settings.json -f throughput_test

It can equally be used as a library:

from finn_plus_driver import FINNDMAOverlay

accel = FINNDMAOverlay("finn-accel.bit", io_shape_dict=io_shape_dict)
output = accel.execute(input_array)

Contents