Merge pull request #5 from fastmachinelearning/feature/gtsrb_cnv

Add Brevitas binarized CNV topology trained on GTSRB

Author: maltanar

models/GTSRB/Brevitas_CNV1W1A/LICENSE.txt

@@ -0,0 +1,40 @@
+Copyright (c) 2023-     Advanced Micro Devices, Inc (Nicholas Fraser)
+Copyright (c) 2018-     Xilinx, Inc                 (Alessandro Pappalardo)
+Copyright (c) 2016-     Facebook, Inc               (Adam Paszke)
+Copyright (c) 2014-     Facebook, Inc               (Soumith Chintala)
+Copyright (c) 2011-2014 Idiap Research Institute    (Ronan Collobert)
+Copyright (c) 2012-2014 Deepmind Technologies       (Koray Kavukcuoglu)
+Copyright (c) 2011-2012 NEC Laboratories America    (Koray Kavukcuoglu)
+Copyright (c) 2011-2013 NYU                         (Clement Farabet)
+Copyright (c) 2006-2010 NEC Laboratories America    (Ronan Collobert, Leon Bottou, Iain Melvin, Jason Weston)
+Copyright (c) 2006      Idiap Research Institute    (Samy Bengio)
+Copyright (c) 2001-2004 Idiap Research Institute    (Ronan Collobert, Samy Bengio, Johnny Mariethoz)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+3. Neither the names of Xilinx, Facebook, Deepmind Technologies, NYU, 
+   NEC Laboratories America and IDIAP Research Institute nor the names 
+   of its contributors may be used to endorse or promote products derived 
+   from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

models/GTSRB/Brevitas_CNV1W1A/README.md

@@ -0,0 +1,22 @@
+# Brevitas GTSRB example
+
+This is the binarized CNV topology from the paper [FINN: A Framework for Fast, Scalable Binarized Neural Network Inference](https://arxiv.org/abs/1612.07119) which is trained
+on the [German Traffic Sign Recognition Benchmark (GTSRB)](https://benchmark.ini.rub.de/gtsrb_news.html) dataset and exported in QONNX format.
+
+## Models
+
+NOTE: Accuracy numbers listed here are provided by the trainer, and are not verified running through QONNX at this time. 
+
+| Name     | Input quantization           | Weight quantization | Activation quantization | Dataset       | Top1 accuracy |
+|----------|------------------------------|---------------------|-------------------------|---------------|---------------|
+| CNV_1W1A | 8 bit                        | 1 bit               | 1 bit                   |  GTSRB      |    96.93%     |
+
+
+## Train
+
+The training scripts for the CNV topology are located in [Brevitas Repo](https://github.com/Xilinx/brevitas/tree/master/src/brevitas_examples/bnn_pynq).
+The original setup uses the CIFAR-10 dataset, which was subsequently modified by [Nicholas Fraser](https://github.com/nickfraser) for GTSRB for this example.
+
+## License
+
+Models are licensed under LICENSE.txt within this directory.