sinabs 3.0.3.dev1__py3-none-any.whl → 3.0.4__py3-none-any.whl

sinabs/__init__.py

@@ -2,9 +2,15 @@ from pbr.version import VersionInfo
 
 __version__ = VersionInfo("sinabs").release_string()
 
-from . import conversion, utils
+from . import conversion, utils, validate_memory_speck
 from .from_torch import from_model
 from .network import Network
 from .nir import from_nir, to_nir
 from .synopcounter import SNNAnalyzer, SynOpCounter
-from .utils import reset_states, set_batch_size, zero_grad
+from .utils import (
+    reset_states,
+    set_batch_size,
+    zero_grad,
+    validate_memory_mapping_speck,
+)
+from .validate_memory_speck import ValidateMapping

sinabs/backend/dynapcnn/discretize.py

@@ -287,7 +287,6 @@ def _discretize_conv_spk_(
             conv_bias = torch.zeros(conv_lyr.out_channels)
 
     if spike_lyr is None:
-
         discr_spk = False
 
         if spk_thr is None or spk_thr_low is None:

sinabs/backend/dynapcnn/dynapcnn_network.py

@@ -344,7 +344,6 @@ class DynapcnnNetwork(nn.Module):
         )
         # Validate config
         if is_compatible:
-            print("Network is valid")
             return config
         else:
             raise ValueError(f"Generated config is not valid for {device}")
@@ -361,8 +360,8 @@ class DynapcnnNetwork(nn.Module):
         try:
             _, is_compatible = self._make_config(device=device_type)
         except ValueError as e:
-            # Catch "No valid mapping found" error
-            if e.args[0] == ("No valid mapping found"):
+            # Catch "No valid mapping found" error, it is the first sentence in the string
+            if e.args[0].find("No valid mapping found.") == 0:
                 return False
             else:
                 raise e

sinabs/backend/dynapcnn/mapping.py

@@ -188,5 +188,8 @@ def recover_mapping(graph, layer_mapping) -> List[Tuple[int, int]]:
             if edge.flow == 1:
                 mapping.append((i, edge.t - len(layer_mapping) - 1))
     if len(mapping) != len(layer_mapping):
-        raise ValueError("No valid mapping found")
+        raise ValueError(
+            "No valid mapping found. "
+            "For Speck family you can use `utils.validate_memory_mapping_speck()` to get more information."
+        )
     return mapping

sinabs/utils.py

@@ -1,10 +1,11 @@
-from typing import List
+from typing import List, Tuple
 
 import numpy as np
 import torch
 import torch.nn as nn
 
 import sinabs
+from .validate_memory_speck import ValidateMapping
 
 
 def reset_states(model: nn.Module) -> None:
@@ -179,3 +180,62 @@ def set_batch_size(model: nn.Module, batch_size: int):
         if isinstance(mod, sinabs.layers.SqueezeMixin):
             mod.batch_size = batch_size
             # reset_states(mod)
+
+
+def validate_memory_mapping_speck(
+    input_feature_size: int,
+    output_feature_size: int,
+    kernel_size: Tuple[int, int],
+    stride: Tuple[int, int],
+    padding: Tuple[int, int],
+    input_dimension: Tuple[int, int] = [64, 64],
+    conv_2d: bool = True,
+):
+    """Helper function to verify if it is possible to map a specific layer on to speck.
+        This function validates kernel and neuron memories. It doesnt check for all the network layers together.
+        It considers the mapping of a Conv2D layer only.
+
+    Args:
+        input_feature_size (int): number of input channels
+        output_feature_size (int): number of output channels
+        kernel_size (Tuple[int, int]): 2D kernel size
+        stride (Tuple[int, int]): 2D stride size
+        padding (Tuple[int, int]): 2D padding size
+        input_dimension (Tuple[int, int]): 2D input dimension size. Defaults to [64,64]
+        conv_2d (bool): if it is mapping a Conv2D layers. Defaults to True. It won't validate other types of network.
+
+    Return:
+        msg (string): Message indicating layer can be mapped with total size of kernel and neuron memories.
+
+    Raises:
+        Exception: if neuron or kernel memories are higher than available on chip.
+    """
+
+    if not conv_2d:
+        raise ValueError("This function only validates Conv2D layers.")
+
+    validate = ValidateMapping(
+        input_feature_size,
+        output_feature_size,
+        kernel_size,
+        stride,
+        padding,
+        [input_dimension[0], input_dimension[1]],
+        conv_2d,
+    )
+    (
+        kernel,
+        neuron,
+        kernel_error_msg,
+        neuron_error_msg,
+    ) = validate.calculate_total_memory()
+
+    if kernel_error_msg != "" or neuron_error_msg != "":
+        raise Exception(kernel_error_msg + neuron_error_msg)
+    else:
+        msg = (
+            "Layer can be mapped successfully. "
+            f"Kernel memory is {kernel:g}Ki and neuron memory is {neuron:g}Ki."
+        )
+
+    return msg

sinabs/validate_memory_speck.py

@@ -0,0 +1,144 @@
+from typing import Tuple
+from matplotlib import pyplot as plt
+from matplotlib import colors
+
+import numpy as np
+
+
+class ValidateMapping:
+    def __init__(
+        self,
+        input_feature_size: int,
+        output_feature_size: int,
+        kernel_size: Tuple[int, int],
+        stride: Tuple[int, int],
+        padding: Tuple[int, int],
+        input_dimension: Tuple[int, int] = [64, 64],
+        conv_2d: bool = True,
+    ):
+        self.input_feature_size = input_feature_size
+        self.output_feature_size = output_feature_size
+
+        self.kernel_size = kernel_size
+        self.stride = stride
+        self.padding = padding
+        self.input_dimension = input_dimension
+
+        # - If not Conv2D layer, assuming it is AvgPool2D layer
+        if not conv_2d:
+            if (
+                kernel_size[0] != kernel_size[1]
+                or kernel_size[0] == 3
+                or kernel_size[0] > 4
+            ):
+                raise Exception(
+                    "Kernel size is limited to 1x1, 2x2 or 4x4 for AvgPool2D layer."
+                )
+
+        if (
+            len(kernel_size) > 2
+            or len(stride) > 2
+            or len(padding) > 2
+            or len(input_dimension) > 2
+        ):
+            raise Exception(
+                "We expect input dimension kernel, stride and padding to be 2D elements, i.e.,"
+                "to have only two positions: x and y."
+            )
+
+        if kernel_size[0] > 16 or kernel_size[1] > 16:
+            raise Exception("Kernel size is limited to, at most, 16x16.")
+
+        if output_feature_size > 1024:
+            raise Exception("Output feature size is limited to, at most, 1024.")
+
+        if not self.check_stride():
+            raise Warning("Kernel stride can be 1, 2, 4 or 8 and, at most, 8x8.")
+
+    def calculate_total_memory(self):
+        kernel_memory = self.calculate_kernel_memory()
+        neuron_memory = self.calculate_neuron_memory()
+
+        kernel_error_msg = self.verify_combined_memories(
+            "kernel", kernel_memory, "neuron", neuron_memory
+        )
+        neuron_error_msg = self.verify_combined_memories(
+            "neuron", neuron_memory, "kernel", kernel_memory
+        )
+
+        print(kernel_error_msg)
+        print(neuron_error_msg)
+        return (
+            kernel_memory / 1024,
+            neuron_memory / 1024,
+            kernel_error_msg,
+            neuron_error_msg,
+        )
+
+    def calculate_kernel_memory(self):
+        return self.input_feature_size * pow(
+            2,
+            np.ceil(np.log2(self.kernel_size[0] * self.kernel_size[1]))
+            + np.ceil(np.log2(self.output_feature_size)),
+        )
+
+    def calculate_neuron_memory(self):
+        fx = (
+            (self.input_dimension[0] - self.kernel_size[0] + 2 * self.padding[0])
+            / self.stride[0]
+        ) + 1
+        fy = (
+            (self.input_dimension[1] - self.kernel_size[1] + 2 * self.padding[1])
+            / self.stride[1]
+        ) + 1
+        return self.output_feature_size * pow(
+            2, (np.ceil(np.log2(fx)) + np.ceil(np.log2(fy)))
+        )
+
+    def check_stride(self):
+        for i in range(len(self.stride)):
+            if (
+                self.stride[i] == 1
+                or self.stride[i] == 2
+                or self.stride[i] == 4
+                or self.stride[i] == 8
+            ):
+                return True
+        return False
+
+    def verify_combined_memories(
+        self, base_name: str, base_memory: int, compared_name: str, compared_memory: int
+    ):
+        # core ids --------- kernel memory -------- neuron memory
+        # [0, 1, 2] ------------- 16Ki ----------------- 64Ki
+        # [3, 4] ---------------- 32Ki ----------------- 32Ki
+        # [5, 6] ---------------- 64Ki ----------------- 16Ki
+        # [7, 8] ---------------- 16Ki ----------------- 16Ki
+
+        base_memory = base_memory / 1024
+        compared_memory = compared_memory / 1024
+
+        error_msg = ""
+        if base_memory > 64:
+            error_msg = (
+                f"{base_name.capitalize()} memory is {base_memory:g}Ki and can not be mapped on chip. "
+                f"{base_name.capitalize()} memory on chip needs to be at most 64Ki."
+            )
+
+        if base_memory > 16 and base_memory <= 32:
+            if compared_memory > 32:
+                error_msg = (
+                    "There is no core on chip to fit neuron and kernel memories. "
+                    f"When {base_name} memory is higher than 16Ki, {compared_name} memory needs to be at most 32Ki. "
+                    f"{base_name.capitalize()} is {base_memory:g}Ki and {compared_name} is {compared_memory:g}Ki."
+                )
+
+        if base_memory > 32:
+            if compared_memory > 16:
+                error_msg = (
+                    "There is no core on chip to fit neuron and kernel memories. "
+                    f"When {base_name} memory is higher than 32Ki, {compared_name} memory needs to be at most 16Ki. "
+                    f"{base_name.capitalize()} is {base_memory:g}Ki and {compared_name} is {compared_memory:g}Ki."
+                )
+
+        return error_msg

{sinabs-3.0.3.dev1.dist-info → sinabs-3.0.4.dist-info}/METADATA

@@ -1,15 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sinabs
-Version: 3.0.3.dev1
+Version: 3.0.4
 Summary: SynSense Spiking Neural Network simulator for deep neural networks (DNNs).
-Home-page: UNKNOWN
 Author: SynSense (formerly AiCTX)
 Author-email: support@synsense.ai
 License: Apache 2.0
 Project-URL: Source code, https://github.com/synsense/sinabs
 Project-URL: Documentation, https://readthedocs.org/projects/sinabs/
 Keywords: spiking neural networks,machine learning,SNN,DYNAPCNN,Speck
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Science/Research
@@ -17,12 +15,25 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS
 Requires-Dist: pbr
 Requires-Dist: numpy
 Requires-Dist: torch>=1.8
 Requires-Dist: nir<=1.0.4
 Requires-Dist: nirtorch
 Requires-Dist: samna>=0.33
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
 
 [![PyPI - Package](https://img.shields.io/pypi/v/sinabs.svg)](https://pypi.org/project/sinabs/)
 [![Documentation Status](https://readthedocs.org/projects/sinabs/badge/?version=main)](https://sinabs.readthedocs.io)
@@ -93,5 +104,3 @@ url = {https://github.com/synsense/sinabs}
 }
 ```
 
-
-

{sinabs-3.0.3.dev1.dist-info → sinabs-3.0.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-sinabs/__init__.py,sha256=JkDiILG7hqkPMBA3IpxOYGuWmUXpIwf2fcAewdn7kdU,332
+sinabs/__init__.py,sha256=vvWzU_lrsSob2JpOdG7ok8Rm0FjR-v7ogYgK6zruAGk,458
 sinabs/cnnutils.py,sha256=MTVTmTnLYMiDQZozfgH7UhMCYQPpOto0vDa0kMjADiA,2406
 sinabs/conversion.py,sha256=k9pNqOtmA4JhKXIyGoFY6Fl8jyZp7DtlmpS4ym8pN0w,2023
 sinabs/from_torch.py,sha256=L_n7BRj7llKI-4Er1cPOZo6VVoInxehMk1PVlDiFIt8,4957
@@ -6,7 +6,8 @@ sinabs/hooks.py,sha256=7jK44SxPcnQhWScvML9QIXyX5sfA_1E-lHpYjz2_4qc,16197
 sinabs/network.py,sha256=If6Qz2MDEpHPHD0bEStDyCif1EUw4ef3CXUQr4og9rA,9489
 sinabs/nir.py,sha256=r72RZ2WNuhnHvQ2MaSJ04J-Bes1mAdzoU9LKbJupZzE,8695
 sinabs/synopcounter.py,sha256=ZF7f9Au-j5wC3gPixWxj4yq8v8KdjDUMJWExyKi6Y5s,12759
-sinabs/utils.py,sha256=134zD1Kj7u2oFPoxgy8bwBrfiHS-ct7A-TlU8ghtL30,5655
+sinabs/utils.py,sha256=wNFwlf03SOYAEgdZiA1cxAf1XEnRXlycutEu2uhDBSQ,7696
+sinabs/validate_memory_speck.py,sha256=8uByUV9VNHncbYX4Wxq3qaepwfp-tH3c2MZeHRZSUeU,5134
 sinabs/activation/__init__.py,sha256=cHXmIvV9fYZhqKVVTzD2F1a6KQklJPgTgDFjNzIEII8,311
 sinabs/activation/quantize.py,sha256=AzrIQbIlSPoiPgueC4XkRGNSeNoU5V9B7mtXbq0Kzk8,1166
 sinabs/activation/reset_mechanism.py,sha256=aKtQFxB8WqzuSir0NocdkqTF_YD7E365QBj66g3wQvE,1419
@@ -17,15 +18,15 @@ sinabs/backend/dynapcnn/__init__.py,sha256=m0Zr7WkmTHyGth0iQ7vsojnXd2Tb0yHE0hW6w
 sinabs/backend/dynapcnn/chip_factory.py,sha256=Avy-CVu4-wxEMNcJmj0XVTfUEX7IGDbvVckMg5enVIo,6910
 sinabs/backend/dynapcnn/config_builder.py,sha256=oGbSwPxRd-qCT4cI6CBupbTl5Jh_B_3RhT3w-jaP8gQ,4795
 sinabs/backend/dynapcnn/crop2d.py,sha256=-FKOQHdx8GjEXK64OlWZyc1GId4FFRptVnt80jLBlcs,1439
-sinabs/backend/dynapcnn/discretize.py,sha256=PyamxI-AoekChUZa_nCKatVre-gXBFWqnzPDcvnDQh4,13475
+sinabs/backend/dynapcnn/discretize.py,sha256=5ZG4KHrIKB79ifGvt1gu6j8OlH0xc51cWQtyQHelJvg,13474
 sinabs/backend/dynapcnn/dvs_layer.py,sha256=Aauw7u7IJvtUkjOpYo1snqzVyFns6DZ5bmZGaj0Y7pA,9468
 sinabs/backend/dynapcnn/dynapcnn_layer.py,sha256=53u_7NqlNqJxTjrOeEOz4WABrYLtmclaN8sAwaSfr9Y,6702
-sinabs/backend/dynapcnn/dynapcnn_network.py,sha256=z6wSBynI7R8SWUS2TG7xKIWXcQNVI86JF1MPp3dXZG0,20547
+sinabs/backend/dynapcnn/dynapcnn_network.py,sha256=ZHNrf-KVwEf1gpUnH9CpHSUCVSAqxLAb6Ks3zbdZ6N0,20556
 sinabs/backend/dynapcnn/dynapcnn_visualizer.py,sha256=MRewU6519dAtAMxf-JlFBrlynJTZeLiDfB0d85-mMFQ,24262
 sinabs/backend/dynapcnn/exceptions.py,sha256=hEei4gOniq3ByYXkJovlAeaUfZ8Q9BWTHTb0DJ9pHeQ,485
 sinabs/backend/dynapcnn/flipdims.py,sha256=I0I1nakrF0ngWBh-2SHHg7OkCOxotqukwHOQ45GWyCs,860
 sinabs/backend/dynapcnn/io.py,sha256=1AN4CcixXM1PFZ6U3LeNGQ71ajSXaV3lTyq__j4sxns,9952
-sinabs/backend/dynapcnn/mapping.py,sha256=JQnu_lzppPwlDOZNwqgyavoPmJ-Oz73VwE0T0azXbyc,5976
+sinabs/backend/dynapcnn/mapping.py,sha256=h63M9hhI6enZtQyq-may9hU7YcnGNCumiHalh8ohMno,6108
 sinabs/backend/dynapcnn/specksim.py,sha256=UKh_lH_yHIZaYEONWsAOChrD-vBdSawBxRBeDHlSv84,17138
 sinabs/backend/dynapcnn/utils.py,sha256=LYihrBIiPTDLUwsUikVOzWva4RwPc27LoHRCUDlDm-4,17934
 sinabs/backend/dynapcnn/chips/__init__.py,sha256=zJQ7f7bp_cF0US1pZ8ga4-3Bo32T0GB9gD2RN3uKlsM,130
@@ -49,10 +50,10 @@ sinabs/layers/to_spike.py,sha256=97ar-tiDZCgckBLdnKoHzm8PjTFwDXra0weOFgAf6_4,331
 sinabs/layers/functional/__init__.py,sha256=v0c7DHizKg8jfelmFYeMMg9vDafKvzoenakc4SPpj84,91
 sinabs/layers/functional/alif.py,sha256=ycJ7rlcBAd-lq5GCDZrcNPeV-7fztt3uy43XhBtTKHI,4599
 sinabs/layers/functional/lif.py,sha256=QRjiWDCBaJFk4J7RRMgktMaLCyN6xEXAKvC9Bu_PICU,4259
-sinabs-3.0.3.dev1.dist-info/AUTHORS,sha256=jdt0oxfM_OW0_e5-ptxORAJ8U0uTzZjaB-F5iF2i50E,1802
-sinabs-3.0.3.dev1.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-sinabs-3.0.3.dev1.dist-info/METADATA,sha256=hlutAzxSv37lzRsc31GiTn2Iczdi7R5cECuubFxjAlI,3656
-sinabs-3.0.3.dev1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-sinabs-3.0.3.dev1.dist-info/pbr.json,sha256=84-FHs3AncXAagUxPme2CI_3qf3KHng4nSI6-x_oj0g,47
-sinabs-3.0.3.dev1.dist-info/top_level.txt,sha256=QOXGzf0ZeDjRnJ9OgAjkk6h5jrh66cwrwvtPJTyfDk8,7
-sinabs-3.0.3.dev1.dist-info/RECORD,,
+sinabs-3.0.4.dist-info/licenses/AUTHORS,sha256=jdt0oxfM_OW0_e5-ptxORAJ8U0uTzZjaB-F5iF2i50E,1802
+sinabs-3.0.4.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+sinabs-3.0.4.dist-info/METADATA,sha256=0ZVtQZcQXqtlrpD6vkkZeQydylC1DneKLWiJpho0Zpg,3887
+sinabs-3.0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sinabs-3.0.4.dist-info/pbr.json,sha256=zYdy8PXt9BBw1ow-q9S5eIaTUBP1ICuh2q7SrAbkG40,47
+sinabs-3.0.4.dist-info/top_level.txt,sha256=QOXGzf0ZeDjRnJ9OgAjkk6h5jrh66cwrwvtPJTyfDk8,7
+sinabs-3.0.4.dist-info/RECORD,,

{sinabs-3.0.3.dev1.dist-info → sinabs-3.0.4.dist-info}/WHEEL

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

sinabs-3.0.4.dist-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "b38b049", "is_release": false}

sinabs-3.0.3.dev1.dist-info/pbr.json

@@ -1 +0,0 @@
-{"git_version": "b584589", "is_release": false}