From 8b39f04ac8ff6bff3bb07a4ecb1600ba78356fa8 Mon Sep 17 00:00:00 2001
From: auphelia <jakobapk@web.de>
Date: Tue, 25 Feb 2020 15:06:01 +0000
Subject: [PATCH] [Transformation] Edit comments in module
---
src/finn/transformation/__init__.py | 2 ++
src/finn/transformation/fpgadataflow/codegen_ipgen.py | 2 ++
src/finn/transformation/fpgadataflow/codegen_ipstitch.py | 3 ++-
src/finn/transformation/fpgadataflow/make_deployment.py | 6 +++---
4 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/src/finn/transformation/__init__.py b/src/finn/transformation/__init__.py
index 3ddce04c1..c3b37661a 100644
--- a/src/finn/transformation/__init__.py
+++ b/src/finn/transformation/__init__.py
@@ -23,6 +23,8 @@ from abc import ABC, abstractmethod
class Transformation(ABC):
+ """Transformation class all transformations are based on. Contains only
+ abstract method apply() every transformation has to fill."""
def __init__(self):
super().__init__()
diff --git a/src/finn/transformation/fpgadataflow/codegen_ipgen.py b/src/finn/transformation/fpgadataflow/codegen_ipgen.py
index 4e1912704..3cf2b5e8c 100644
--- a/src/finn/transformation/fpgadataflow/codegen_ipgen.py
+++ b/src/finn/transformation/fpgadataflow/codegen_ipgen.py
@@ -33,7 +33,9 @@ class CodeGen_ipgen(Transformation):
and create folder that contains all the generated files.
All nodes in the graph must have the fpgadataflow backend attribute and
transformation gets additional arguments:
+
* fpgapart (string)
+
* clk in ns (int)
Outcome if succesful: Node attribute "code_gen_dir_ipgen" contains path to folder
diff --git a/src/finn/transformation/fpgadataflow/codegen_ipstitch.py b/src/finn/transformation/fpgadataflow/codegen_ipstitch.py
index a39b3c439..7fe8b81c3 100644
--- a/src/finn/transformation/fpgadataflow/codegen_ipstitch.py
+++ b/src/finn/transformation/fpgadataflow/codegen_ipstitch.py
@@ -9,7 +9,8 @@ class CodeGen_ipstitch(Transformation):
"""Create a Vivado IP Block Design project from all the generated IPs of a
graph. All nodes in the graph must have the fpgadataflow backend attribute,
and the CodeGen_ipgen transformation must have been previously run on
- the graph. The resulting block design is also packaged as IP.
+ the graph. The resulting block design is also packaged as IP. The
+ transformation gets the fpgapart as a string.
Outcome if successful: sets the vivado_stitch_proj attribute in the ONNX
ModelProto's metadata_props field, with the created project dir as the
diff --git a/src/finn/transformation/fpgadataflow/make_deployment.py b/src/finn/transformation/fpgadataflow/make_deployment.py
index 98009d8c0..79829260d 100644
--- a/src/finn/transformation/fpgadataflow/make_deployment.py
+++ b/src/finn/transformation/fpgadataflow/make_deployment.py
@@ -10,9 +10,9 @@ from finn.util.basic import make_build_dir
class DeployToPYNQ(Transformation):
"""Collects all necessary files for deployment and copies them to the PYNQ board.
Expects information about PYNQ board to make scp possible:
- * ip address of board
- * username and password for board
- * target directory where the files are stored on the board"""
+
+ IP address of board, username and password for board and target directory where
+ the files are stored on the board"""
def __init__(self, ip, username, password, target_dir):
super().__init__()
--
GitLab