From 28118f5fe7bf3dff484474f68ed8da76d9530f2a Mon Sep 17 00:00:00 2001
From: Yaman Umuroglu <maltanar@gmail.com>
Date: Tue, 9 Jun 2020 11:10:14 +0100
Subject: [PATCH] [Util] add comment about trace depths
---
src/finn/util/basic.py | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/finn/util/basic.py b/src/finn/util/basic.py
index 3880bb959..338ca4674 100644
--- a/src/finn/util/basic.py
+++ b/src/finn/util/basic.py
@@ -56,6 +56,11 @@ def get_rtlsim_trace_depth():
via the RTLSIM_TRACE_DEPTH environment variable. If the env.var. is
undefined, the default value of 1 is returned. A trace depth of 1
will only show top-level signals and yield smaller .vcd files.
+
+ The following depth values are of interest for whole-network stitched IP
+ rtlsim:
+ - level 1 shows top-level input/output streams
+ - level 2 shows per-layer input/output streams
"""
try:
--
GitLab