nirviz 0.1.0__py3-none-any.whl

nirviz/__init__.py

@@ -0,0 +1,12 @@
+from importlib.metadata import version as metadata_version, PackageNotFoundError
+
+# Exposing imports
+from .nirviz import visualize
+
+try:
+    # For pyproject.toml dynamic versioning
+    __version__ = version = metadata_version("nirviz")
+    del metadata_version
+except PackageNotFoundError:
+    print('nirviz: package not found')
+    pass

nirviz/__main__.py

@@ -0,0 +1,31 @@
+import argparse
+import sys
+
+import nirviz
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="CLI tool for visualizing NIR graphs.")
+    parser.add_argument("file", type=argparse.FileType('r'), help="The NIR graph file to read from.")
+    parser.add_argument("output", type=str, default="stdout", nargs='?', help="The output file to write the graph to. Defaults to stdout.")
+    parser.add_argument("yaml", type=argparse.FileType('r'), default="./style.yml", nargs='?', help="Style file defined in yaml. Defaults to ./style.yml.")
+    args = parser.parse_args()
+
+    nir_file = args.file.name
+    yaml_file = args.yaml.name
+    # Load the NIR graph
+    if args.output == "stdout":
+        graph = nirviz.visualize(nir_file, style_file=yaml_file)
+        graph_svg = str(graph)
+        sys.stdout.write(graph_svg)
+    elif args.output.endswith(".svg"):
+        graph = nirviz.visualize(nir_file, style_file=yaml_file)
+        graph_svg = str(graph)
+        with open(args.output, "w") as f:
+            f.write(graph_svg)
+    elif args.output.endswith(".png"):
+        graph = nirviz.visualize(nir_file, style_file=yaml_file)
+        graph_image = graph.to_image()
+        graph_image.save(args.output)
+
+    else:
+        raise ValueError("Output file must be either .svg or .png format.")

nirviz/nirviz.py

@@ -0,0 +1,72 @@
+from dataclasses import dataclass, field
+import yaml
+import re
+import graphviz
+import cairosvg
+import nir
+import typing
+import importlib.util
+import pathlib
+import PIL
+import io
+
+
+@dataclass
+class visualize:
+    nir_graph: typing.Union[nir.NIRGraph, str, pathlib.Path]
+    style_file: pathlib.Path = field(default_factory=lambda: pathlib.Path("./style.yml"))
+
+    def __post_init__(self):
+        if isinstance(self.nir_graph, (str, pathlib.Path)):
+            self.nir_graph = nir.read(self.nir_graph)
+
+        self.style_dict = self.__load_style_file()
+        self.viz_graph = self.__construct_graph()
+
+    def __load_style_file(self) -> typing.Dict[str, typing.Dict[str, str]]:
+        with open(self.style_file, 'r') as f:
+            config = yaml.safe_load(f)
+        return config
+
+    def __pick_style(self, name: str) -> typing.Dict[str, str]:
+        categories = self.style_dict['node-categories']
+        for cat_id in categories:
+            cat = categories[cat_id]
+            if name in cat['patterns']:
+                return cat['style']
+
+        return self.style_dict['defaults']['node']['style']
+
+
+    def __construct_graph(self) -> graphviz.Digraph:
+        viz_graph = graphviz.Digraph(format="svg",
+                                     graph_attr={'rankdir': 'LR'})
+        # Generate nodes
+        for node_id in self.nir_graph.nodes:
+            name = type(self.nir_graph.nodes[node_id]).__name__
+            style = self.__pick_style(name)
+            viz_graph.node(node_id, label=name, **style)
+
+        # Generate edges
+        for src_id, tgt_id in self.nir_graph.edges:
+            viz_graph.edge(src_id, tgt_id)
+
+        return viz_graph
+
+    def show(self) -> None:
+        if importlib.util.find_spec("IPython"):
+            import IPython
+
+            svg_output = self.viz_graph.pipe(format="svg")
+            image = IPython.display.SVG(svg_output)
+            IPython.display.display(image)
+        else:
+            print("error: cannot display graph: no IPython environment detected.")
+
+    def to_image(self) -> PIL.Image.Image:
+        svg_output = self.viz_graph.pipe(format="svg")
+        png_bytes = cairosvg.svg2png(bytestring=svg_output)
+        return PIL.Image.open(io.BytesIO(png_bytes))
+
+    def __repr__(self) -> str:
+        return self.viz_graph.pipe(format="svg", encoding="utf-8")

nirviz-0.1.0.dist-info/METADATA

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: nirviz
+Version: 0.1.0
+Summary: Visualisation tool for the Neuromorphic Intermediate Representation
+Author-email: Jens Egholm Pedersen <jens@jepedersen.dk>, Michail Rontionov <mrontionov@mront.io>
+License-Expression: BSD-3-Clause
+Project-URL: homepage, https://github.com/open-neuromorphic/nirviz
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: nir
+Requires-Dist: graphviz
+Requires-Dist: cairosvg
+Requires-Dist: pyyaml
+Dynamic: license-file
+
+# Neuromorphic Intermediate Representation Visualisation Tool
+
+Turn your NIR definitions into a nice graph, the original publication serving as a template.
+
+Customise your node colour preferences in [style.yml](./style.yml), and quickly generate graphs from your neuromorphic networks.
+
+This work is in progress.
+
+## Running Example (Jupyter Notebook)
+By running the following code (from a notebook),
+```python
+import nir
+import nirviz
+import numpy as np
+
+
+a = np.random.randn(2)
+ir = nir.NIRGraph(
+    nodes={
+        "input": nir.Input(input_type=np.array([2])),
+        "affine1": nir.Affine(weight=np.zeros((2,2)), bias=False),
+        "cu1": nir.CubaLIF(tau_mem=a, tau_syn=a, r=a, v_leak=a, v_threshold=a, v_reset=a),
+        "affine_rec": nir.Affine(weight=np.zeros((2,2)), bias=False),
+        "affine2": nir.Affine(weight=np.zeros((2,2)), bias=False),
+        "cu2": nir.CubaLIF(tau_mem=a, tau_syn=a, r=a, v_leak=a, v_threshold=a, v_reset=a),
+        "output": nir.Output(output_type=np.array([2]))
+    },
+    edges=[("input", "affine1"), ("affine1", "cu1"), ("affine_rec", "cu1"),  ("cu1", "affine_rec"), ("cu1", "affine2"), ("affine2", "cu2"), ("cu2", "output")])
+
+viz = nirviz.visualize(ir)
+viz.show()
+```
+
+You would get the following visualisation
+
+<picture>
+<img alt="nirviz output" src="https://raw.githubusercontent.com/open-neuromorphic/nirviz/main/img/srnn.png">
+</picture>
+
+Similar to Figure 3 of the publication.
+
+<picture>
+<img alt="Figure 3 of NIR paper for comparison to output" src="https://raw.githubusercontent.com/open-neuromorphic/nirviz/main/img/fig3.png">
+</picture>
+
+## Running example (CLI)
+To convert a saved NIR graph (e.g. srnn.nir) to a PNG or SVG, you can use one of the following commands:
+```bash
+python -m nirviz srnn.nir              # SVG -> stdout
+python -m nirviz srnn.nir img/srnn.png # PNG -> file
+python -m nirviz srnn.nir img/srnn.svg # SVG -> file
+```

nirviz-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+nirviz/__init__.py,sha256=RqjX1IhDxsVnfwW6xha5rTZ4gcjbmFjjgVIwdh66qB0,338
+nirviz/__main__.py,sha256=pjNFvsnk6rr1obCBcmUQ82rC3tOnA1pUzMAPlEw76Ck,1315
+nirviz/nirviz.py,sha256=Ux29RrDZjUPen1ycQfxBG_LuN4qqzWfyLkfCN5dNKgM,2340
+nirviz-0.1.0.dist-info/licenses/LICENSE,sha256=fFCmUBqfYPQBzBbI51UGu3yGokvK8pTdwo3pJHXLrp4,1509
+nirviz-0.1.0.dist-info/METADATA,sha256=CP8cAocxvHOodU7jRYncVsihydD8XZRSg-xvltlyESE,2936
+nirviz-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nirviz-0.1.0.dist-info/top_level.txt,sha256=jVzOdKkNMl2P6SiMBUFIbNQy7qd945yixwXyijuwN4A,7
+nirviz-0.1.0.dist-info/RECORD,,

nirviz-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

nirviz-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2025, open-neuromorphic/nirviz
+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 name of the copyright holder 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 HOLDER 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.

nirviz-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+nirviz