Add docs

Samsung · Feb 10, 2023 · cf31e94 · cf31e94
1 parent f619535
commit cf31e94
Show file tree

Hide file tree

Showing 10 changed files with 55 additions and 0 deletions.
diff --git a/docs/VisualTensorView.jpg b/docs/VisualTensorView.jpg
diff --git a/docs/VisualTensorView.md b/docs/VisualTensorView.md
@@ -0,0 +1,55 @@
+# Visual Tensor View
+
+## Table of Contents
+- [About](#about)
+- [How to use](#how-to-use)
+
+## About
+
+Visual Tensor View is a tool that alows to visualize tensor data as a 2D-heatmap.
+
+<img src="./VisualTensorView.jpg"/>
+
+## How to use
+
+Currently Visual Tensor View is integrated into property sidebar of Circle Graph View.
+The visualizer is shown for all node properties that are tensors of 2 or more dimentions:
+
+<img src="./VisualTensorViewExample.jpg"/>
+
+In order to visualize tensor data:
+- we need a *.circle model that contains at least one node with tensor properties with 2 or more dimentions like 'weights', 'filter', etc.
+- open a folder that contains such model.
+- click on the model file in Explorer.
+- click on such node (Conv2D, for example).
+<img src="./VisualTensorViewNode.jpg"/>
+
+- in 'NODE PROPERTIES' sidebar find 'INPUTS' containing the tensor property ('filter' in case of Conv2D).
+- expand it with '+' button.
+<img src="./VisualTensorViewExpand.jpg"/>
+
+- the visualizer should appear.
+<img src="./VisualTensorViewExpanded.jpg"/>
+
+- you can modify the heatmap scale or swap 'x' and 'y' using respective UI elements.
+<img src="./VisualTensorViewScale.jpg"/>
+
+- the heatmap colors correspond to respective tensor values, the higher wavelength, the higher value:
+    * 'blue' - the lowest value in the current heatmap
+    * 'green' - the value is about (min + max) / 2
+    * 'red' - the highest value in the current heatmap
+
+- hover the mouse over the heatmap pixel to see the actual value in the tooltip.
+<img src="./VisualTensorViewHeatmap.jpg"/>
+
+- if the tensor is 2D all tensor data is shown as a 2D-heatmap at once.
+
+- if the tensor is 3D, 4D...:
+    * exactly two axes should be selected with the checkboxes, the selected axes correspond to 'x' and 'y' of the heatmap.
+    <img src="./VisualTensorViewAxes.jpg"/>
+
+    * for all other axes fixed values should be set.
+    <img src="./VisualTensorViewValues.jpg"/>
+
+    * in this example the heatmap point (x, y) corresponds to tensor[5][y][2][x].
+
diff --git a/docs/VisualTensorViewAxes.jpg b/docs/VisualTensorViewAxes.jpg
diff --git a/docs/VisualTensorViewExample.jpg b/docs/VisualTensorViewExample.jpg
diff --git a/docs/VisualTensorViewExpand.jpg b/docs/VisualTensorViewExpand.jpg
diff --git a/docs/VisualTensorViewExpanded.jpg b/docs/VisualTensorViewExpanded.jpg
diff --git a/docs/VisualTensorViewHeatmap.jpg b/docs/VisualTensorViewHeatmap.jpg
diff --git a/docs/VisualTensorViewNode.jpg b/docs/VisualTensorViewNode.jpg
diff --git a/docs/VisualTensorViewScale.jpg b/docs/VisualTensorViewScale.jpg
diff --git a/docs/VisualTensorViewValues.jpg b/docs/VisualTensorViewValues.jpg