femtocrux 1.2.1__py3-none-any.whl → 2.0.0__py3-none-any.whl

femtocrux/VERSION

@@ -1 +1 @@
-1.2.1
+2.0.0

femtocrux/client/client.py

@@ -11,12 +11,16 @@ import pickle
 import queue
 import sys
 import time
-from typing import Any, List, Tuple, Union
+from typing import Any, List, Tuple
 from contextlib import contextmanager
 
 from fmot.fqir import GraphProto
 
-from femtocrux.util.utils import numpy_to_ndarray, ndarray_to_numpy, get_channel_options
+from femtocrux.util.utils import (
+    get_channel_options,
+    serialize_sim_inputs_message,
+    deserialize_simulation_output,
+)
 
 # GRPC artifacts
 import femtocrux.grpc.compiler_service_pb2 as cs_pb2
@@ -214,34 +218,17 @@ class Simulator:
 
     def simulate(
         self,
-        inputs: Union[np.array, Iterable[np.array]],
-        quantize_inputs: bool = False,
-        dequantize_outputs: bool = False,
-        input_period: float = None,
+        inputs: Iterable[np.array],
+        input_period: float = 0.016,
     ) -> List[np.array]:
         """
         Simulates the model on the given inputs.
 
-        :type inputs: array or iterable of arrays, required
-        :param inputs: The input tensors.
-
-        :type quantize_inputs: bool, optional
-        :param quantize_inputs: If true, quantizes each input from float to integer
-            using its scale :math:`a` and zero point :math:`z`, according to the formula
-        .. math::
-            f(x) = a (x - z)
-
-        :type dequantize_outputs: bool, optional
-        :param dequantize_outputs: If true, dequantizes each output from integer to
-            float using its scale :math:`a` and zero point :math:`z`, according to the
-            formula
-        .. math::
-            g(x) = \\frac{x}{a} + z.
-
-        :param sim_duration: The total simulation time, in seconds. Used to estimate
-        static power consumption. For example, in a streaming model, this should be the
-        time elapsed between model invocations. By default, this is just the estimated
-        latency of the model.
+        :param inputs: The input tensors in a dictionary of:
+            {
+                "input_name1": np.ndarray(int16 types ...),
+                "input_name2": np.ndarray([int16 types ...])
+            }
         :type input_period (float, optional): Duration between each input in a sequence,
             in seconds.
 
@@ -249,24 +236,14 @@ class Simulator:
         :return: The output tensors.
 
         """
-        # FIXME need to handle multiple inputs
-        # Convert a single ndarray to a list containing that input.
-        # Otherwise, this will be interpreted as an iterable of (n-1)-d arrays
-        if isinstance(inputs, np.ndarray):
-            inputs = [inputs]
 
         simulation_request = cs_pb2.simulation_input(
-            data=cs_pb2.simulation_data(
-                data=[numpy_to_ndarray(x) for x in inputs],
-                quantize_inputs=quantize_inputs,
-                dequantize_outputs=dequantize_outputs,
-                input_period=input_period,
-            )
+            data=serialize_sim_inputs_message(inputs, input_period)
         )
         self._send_request(simulation_request)
         response = self._get_response()
 
-        return [ndarray_to_numpy(x) for x in response.data], response.report
+        return deserialize_simulation_output(response.outputs), response.report
 
 
 class CompilerClientImpl:
@@ -348,6 +325,9 @@ class CompilerClientImpl:
         """
         return Simulator(client=self, model=model, options=options)
 
+    def get_simulator_object(self, model: Model, options: dict = {}) -> Simulator:
+        return self.simulate(model, options)
+
     def _server_version(self) -> str:
         """Queries the femtocrux version running on the server."""
         response = self.stub.version(google.protobuf.empty_pb2.Empty())

femtocrux/grpc/compiler_service_pb2.py

@@ -26,13 +26,17 @@ from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2
 from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16\x63ompiler_service.proto\x12\nfscompiler\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1cgoogle/protobuf/struct.proto\"g\n\x04\x66qir\x12\r\n\x05model\x18\x01 \x01(\x0c\x12\x16\n\tbatch_dim\x18\x02 \x01(\x03H\x00\x88\x01\x01\x12\x19\n\x0csequence_dim\x18\x03 \x01(\x03H\x01\x88\x01\x01\x42\x0c\n\n_batch_dimB\x0f\n\r_sequence_dim\"G\n\x06tflite\x12\r\n\x05model\x18\x01 \x01(\x0c\x12\x1b\n\x0esignature_name\x18\x02 \x01(\tH\x00\x88\x01\x01\x42\x11\n\x0f_signature_name\"\x90\x01\n\x05model\x12 \n\x04\x66qir\x18\x01 \x01(\x0b\x32\x10.fscompiler.fqirH\x00\x12$\n\x06tflite\x18\x02 \x01(\x0b\x32\x12.fscompiler.tfliteH\x00\x12-\n\x07options\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructH\x01\x88\x01\x01\x42\x04\n\x02irB\n\n\x08_options\"&\n\x06status\x12\x0f\n\x07success\x18\x01 \x01(\x08\x12\x0b\n\x03msg\x18\x02 \x01(\t\"I\n\x12\x63ompiled_artifacts\x12\x0f\n\x07\x62itfile\x18\x01 \x01(\x0c\x12\"\n\x06status\x18\x02 \x01(\x0b\x32\x12.fscompiler.status\"&\n\x07ndarray\x12\x0c\n\x04\x64\x61ta\x18\x01 \x03(\x02\x12\r\n\x05shape\x18\x02 \x03(\x03\"\x14\n\x04\x64\x61ta\x12\x0c\n\x04\x64\x61ta\x18\x01 \x01(\x0c\"\xc1\x01\n\x0fsimulation_data\x12!\n\x04\x64\x61ta\x18\x01 \x03(\x0b\x32\x13.fscompiler.ndarray\x12\x17\n\x0fquantize_inputs\x18\x02 \x01(\x08\x12\x1a\n\x12\x64\x65quantize_outputs\x18\x03 \x01(\x08\x12\x19\n\x0csim_duration\x18\x04 \x01(\x02H\x00\x88\x01\x01\x12\x19\n\x0cinput_period\x18\x05 \x01(\x02H\x01\x88\x01\x01\x42\x0f\n\r_sim_durationB\x0f\n\r_input_period\"t\n\x10simulation_input\x12\"\n\x05model\x18\x01 \x01(\x0b\x32\x11.fscompiler.modelH\x00\x12+\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x1b.fscompiler.simulation_dataH\x00\x42\x0f\n\rmodel_or_data\"j\n\x11simulation_output\x12!\n\x04\x64\x61ta\x18\x01 \x03(\x0b\x32\x13.fscompiler.ndarray\x12\x0e\n\x06report\x18\x02 \x01(\t\x12\"\n\x06status\x18\x03 \x01(\x0b\x32\x12.fscompiler.status\"\x1f\n\x0cversion_info\x12\x0f\n\x07version\x18\x01 \x01(\t2\x85\x02\n\x07\x43ompile\x12>\n\x07\x63ompile\x12\x11.fscompiler.model\x1a\x1e.fscompiler.compiled_artifacts\"\x00\x12,\n\x04ping\x12\x10.fscompiler.data\x1a\x10.fscompiler.data\"\x00\x12M\n\x08simulate\x12\x1c.fscompiler.simulation_input\x1a\x1d.fscompiler.simulation_output\"\x00(\x01\x30\x01\x12=\n\x07version\x12\x16.google.protobuf.Empty\x1a\x18.fscompiler.version_info\"\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16\x63ompiler_service.proto\x12\nfscompiler\x1a\x1bgoogle/protobuf/empty.proto\x1a\x1cgoogle/protobuf/struct.proto\"g\n\x04\x66qir\x12\r\n\x05model\x18\x01 \x01(\x0c\x12\x16\n\tbatch_dim\x18\x02 \x01(\x03H\x00\x88\x01\x01\x12\x19\n\x0csequence_dim\x18\x03 \x01(\x03H\x01\x88\x01\x01\x42\x0c\n\n_batch_dimB\x0f\n\r_sequence_dim\"G\n\x06tflite\x12\r\n\x05model\x18\x01 \x01(\x0c\x12\x1b\n\x0esignature_name\x18\x02 \x01(\tH\x00\x88\x01\x01\x42\x11\n\x0f_signature_name\"\x90\x01\n\x05model\x12 \n\x04\x66qir\x18\x01 \x01(\x0b\x32\x10.fscompiler.fqirH\x00\x12$\n\x06tflite\x18\x02 \x01(\x0b\x32\x12.fscompiler.tfliteH\x00\x12-\n\x07options\x18\x03 \x01(\x0b\x32\x17.google.protobuf.StructH\x01\x88\x01\x01\x42\x04\n\x02irB\n\n\x08_options\"&\n\x06status\x12\x0f\n\x07success\x18\x01 \x01(\x08\x12\x0b\n\x03msg\x18\x02 \x01(\t\"I\n\x12\x63ompiled_artifacts\x12\x0f\n\x07\x62itfile\x18\x01 \x01(\x0c\x12\"\n\x06status\x18\x02 \x01(\x0b\x32\x12.fscompiler.status\"5\n\x07ndarray\x12\x0c\n\x04\x64\x61ta\x18\x01 \x01(\x0c\x12\r\n\x05shape\x18\x02 \x03(\x03\x12\r\n\x05\x64type\x18\x03 \x01(\t\"\x14\n\x04\x64\x61ta\x12\x0c\n\x04\x64\x61ta\x18\x01 \x01(\x0c\"\xe6\x01\n\x0fsimulation_data\x12\x37\n\x06inputs\x18\x01 \x03(\x0b\x32\'.fscompiler.simulation_data.InputsEntry\x12\x19\n\x0csim_duration\x18\x02 \x01(\x02H\x00\x88\x01\x01\x12\x19\n\x0cinput_period\x18\x03 \x01(\x02H\x01\x88\x01\x01\x1a\x42\n\x0bInputsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\"\n\x05value\x18\x02 \x01(\x0b\x32\x13.fscompiler.ndarray:\x02\x38\x01\x42\x0f\n\r_sim_durationB\x0f\n\r_input_period\"t\n\x10simulation_input\x12\"\n\x05model\x18\x01 \x01(\x0b\x32\x11.fscompiler.modelH\x00\x12+\n\x04\x64\x61ta\x18\x02 \x01(\x0b\x32\x1b.fscompiler.simulation_dataH\x00\x42\x0f\n\rmodel_or_data\"\xc9\x01\n\x11simulation_output\x12;\n\x07outputs\x18\x01 \x03(\x0b\x32*.fscompiler.simulation_output.OutputsEntry\x12\x0e\n\x06report\x18\x02 \x01(\t\x12\"\n\x06status\x18\x03 \x01(\x0b\x32\x12.fscompiler.status\x1a\x43\n\x0cOutputsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\"\n\x05value\x18\x02 \x01(\x0b\x32\x13.fscompiler.ndarray:\x02\x38\x01\"\x1f\n\x0cversion_info\x12\x0f\n\x07version\x18\x01 \x01(\t2\x85\x02\n\x07\x43ompile\x12>\n\x07\x63ompile\x12\x11.fscompiler.model\x1a\x1e.fscompiler.compiled_artifacts\"\x00\x12,\n\x04ping\x12\x10.fscompiler.data\x1a\x10.fscompiler.data\"\x00\x12M\n\x08simulate\x12\x1c.fscompiler.simulation_input\x1a\x1d.fscompiler.simulation_output\"\x00(\x01\x30\x01\x12=\n\x07version\x12\x16.google.protobuf.Empty\x1a\x18.fscompiler.version_info\"\x00\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'compiler_service_pb2', _globals)
 if not _descriptor._USE_C_DESCRIPTORS:
   DESCRIPTOR._loaded_options = None
+  _globals['_SIMULATION_DATA_INPUTSENTRY']._loaded_options = None
+  _globals['_SIMULATION_DATA_INPUTSENTRY']._serialized_options = b'8\001'
+  _globals['_SIMULATION_OUTPUT_OUTPUTSENTRY']._loaded_options = None
+  _globals['_SIMULATION_OUTPUT_OUTPUTSENTRY']._serialized_options = b'8\001'
   _globals['_FQIR']._serialized_start=97
   _globals['_FQIR']._serialized_end=200
   _globals['_TFLITE']._serialized_start=202
@@ -44,17 +48,21 @@ if not _descriptor._USE_C_DESCRIPTORS:
   _globals['_COMPILED_ARTIFACTS']._serialized_start=462
   _globals['_COMPILED_ARTIFACTS']._serialized_end=535
   _globals['_NDARRAY']._serialized_start=537
-  _globals['_NDARRAY']._serialized_end=575
-  _globals['_DATA']._serialized_start=577
-  _globals['_DATA']._serialized_end=597
-  _globals['_SIMULATION_DATA']._serialized_start=600
-  _globals['_SIMULATION_DATA']._serialized_end=793
-  _globals['_SIMULATION_INPUT']._serialized_start=795
-  _globals['_SIMULATION_INPUT']._serialized_end=911
-  _globals['_SIMULATION_OUTPUT']._serialized_start=913
-  _globals['_SIMULATION_OUTPUT']._serialized_end=1019
-  _globals['_VERSION_INFO']._serialized_start=1021
-  _globals['_VERSION_INFO']._serialized_end=1052
-  _globals['_COMPILE']._serialized_start=1055
-  _globals['_COMPILE']._serialized_end=1316
+  _globals['_NDARRAY']._serialized_end=590
+  _globals['_DATA']._serialized_start=592
+  _globals['_DATA']._serialized_end=612
+  _globals['_SIMULATION_DATA']._serialized_start=615
+  _globals['_SIMULATION_DATA']._serialized_end=845
+  _globals['_SIMULATION_DATA_INPUTSENTRY']._serialized_start=745
+  _globals['_SIMULATION_DATA_INPUTSENTRY']._serialized_end=811
+  _globals['_SIMULATION_INPUT']._serialized_start=847
+  _globals['_SIMULATION_INPUT']._serialized_end=963
+  _globals['_SIMULATION_OUTPUT']._serialized_start=966
+  _globals['_SIMULATION_OUTPUT']._serialized_end=1167
+  _globals['_SIMULATION_OUTPUT_OUTPUTSENTRY']._serialized_start=1100
+  _globals['_SIMULATION_OUTPUT_OUTPUTSENTRY']._serialized_end=1167
+  _globals['_VERSION_INFO']._serialized_start=1169
+  _globals['_VERSION_INFO']._serialized_end=1200
+  _globals['_COMPILE']._serialized_start=1203
+  _globals['_COMPILE']._serialized_end=1464
 # @@protoc_insertion_point(module_scope)

femtocrux/server/__init__.py

@@ -0,0 +1 @@
+from .compiler_frontend import CompilerFrontend, TorchCompiler  # noqa: F401

femtocrux/server/compiler_frontend.py

@@ -0,0 +1,168 @@
+"""
+ Copyright Femtosense 2024
+
+ By using this software package, you agree to abide by the terms and conditions
+ in the license agreement found at https://femtosense.ai/legal/eula/
+"""
+
+import numpy as np
+import os
+import tempfile
+import torch
+import zipfile
+
+from fmot import ConvertedModel
+from fmot.fqir import GraphProto
+from femtomapper import MapperConf, Mapper, MapperState
+from femtobehav.fasmir import FASMIR
+from femtobehav.sim import SimRunner
+from typing import Any
+
+
+class CompilerFrontend:
+    """A generic compiler frontend, must be subclassed for each input IR/framework"""
+
+    def __init__(self, input_ir: Any, fasmir: FASMIR = None):
+        self.input_ir = input_ir
+        self.fasmir = fasmir
+        # self.io_wrapper = io_wrapper
+
+    @property
+    def is_compiled(self):
+        return self.fasmir is not None
+
+    def _compile(self, input_ir: Any, options: dict) -> FASMIR:
+        """
+        Runs FM compiler to generate FASMIR, and encode io information in a
+        SimIOWrapper object.
+
+        Must be implemented for each frontend subclass.
+
+        returns FASMIR
+        """
+        raise NotImplementedError(
+            "Subclasses need to implement this based on their input ir"
+        )
+
+    def compile(self, options: dict = {}):
+        if not self.is_compiled:
+            self.fasmir = self._compile(self.input_ir, options)
+
+    def dump_bitfile(self, encrypt: bool = True) -> bytes:
+        """Dumps a bitfile used to program the SPU."""
+        if not self.is_compiled:
+            raise RuntimeError("Model must be compiled before dumping bitfile")
+
+        with tempfile.TemporaryFile() as tmpfile:
+            with tempfile.TemporaryDirectory() as dirname:
+                # Dump memory files to a directory
+                runner = SimRunner(self.fasmir, data_dir=dirname, encrypt=encrypt)
+                runner.reset()
+                runner.finish()
+
+                # Archive the directory
+                with zipfile.ZipFile(
+                    tmpfile, mode="w", compression=zipfile.ZIP_DEFLATED
+                ) as archive:
+                    for relpath in os.listdir(dirname):
+                        abspath = os.path.join(dirname, relpath)
+                        archive.write(abspath, arcname=relpath)
+
+            # Read out the bytes in the archive
+            tmpfile.seek(0)
+            bitfile = tmpfile.read()
+
+        return bitfile
+
+    def _get_padded_len(self, fasmir: FASMIR, name: str):
+        try:
+            fasmir_var = fasmir.data_vars[name]
+        except KeyError:
+            raise ValueError(
+                "Failed to find FASMIR variable corresponding to name %s" % name
+            )
+        return fasmir_var.numpy.shape[0]
+
+    def run_behavioral_simulator(
+        self, inputs: dict[str, np.ndarray], input_period: float = None, **kwargs
+    ):
+        """
+        Runs the behavioral simulator and returns outputs and metrics.
+
+        Arguments:
+            args (np.ndarray): Input tensors to the simulator, as numpy arrays. Either
+                               floating-point or integer (see `quantize_inputs` for
+                               more detail on input datatypes).
+            input_period (float, optional): total simulation time.
+
+        """
+        runner = SimRunner(self.fasmir, **kwargs)
+        runner.reset()
+        outputs, __, __ = runner.run(inputs)
+        metrics = runner.get_metrics(input_period, concise=True, as_yamlable=True)
+        runner.finish()
+        return outputs, metrics
+
+
+def _compile_fqir(graph: GraphProto, options: dict) -> FASMIR:
+    mapper_conf = MapperConf(**options)
+    mapper = Mapper(mapper_conf)
+    mapper_state = MapperState(fqir=graph)
+
+    # compile:
+    mapper_state = mapper.do(mapper_state)
+
+    # extract fasmir
+    fasmir = mapper_state.fasmir
+    return fasmir
+
+
+class TorchCompiler(CompilerFrontend):
+    def __init__(self, graph: GraphProto, batch_dim: int = None, seq_dim: int = None):
+        assert isinstance(graph, GraphProto)
+
+        super().__init__(input_ir=graph)
+        self.batch_dim = batch_dim
+        self.seq_dim = seq_dim
+
+    def _compile(self, input_ir: GraphProto, options: dict) -> FASMIR:
+        fasmir = _compile_fqir(input_ir, options)
+        # wrapper = self._get_fqir_iowrapper(input_ir, fasmir)
+        return fasmir
+
+    @classmethod
+    def from_fqir(cls, graph: GraphProto, batch_dim: int = None, seq_dim: int = None):
+        assert isinstance(graph, GraphProto)
+        return cls(graph, batch_dim, seq_dim)
+
+    @classmethod
+    def from_converted_model(
+        cls,
+        model: ConvertedModel,
+        batch_dim: int = None,
+        seq_dim: int = None,
+        experimental_tracing=False,
+    ):
+        assert isinstance(model, ConvertedModel)
+        graph = model.trace(experimental_hybrid_tracing=experimental_tracing)
+        return cls(graph, batch_dim, seq_dim)
+
+    @classmethod
+    def from_torch_module(
+        cls,
+        module: torch.nn.Module,
+        calibration_data,
+        precision: str = "double",
+        batch_dim: int = None,
+        seq_dim: int = None,
+        experimental_tracing=False,
+        conversion_kwargs: dict = {},
+    ):
+        cmodel = ConvertedModel(
+            module, precision, batch_dim=batch_dim, seq_dim=seq_dim, **conversion_kwargs
+        )
+        cmodel.quantize(calibration_data)
+
+        return TorchCompiler.from_converted_model(
+            cmodel, batch_dim, seq_dim, experimental_tracing
+        )

femtocrux/server/server.py

@@ -1,28 +1,29 @@
 import argparse
 from collections.abc import Iterable
 import concurrent
-import google.protobuf.json_format
+from google.protobuf.json_format import MessageToDict
 import grpc
 import logging
 import pickle
 import sys
 
-from femtocrux.femtostack.common import CompilerFrontend
-from femtocrux.femtostack.tflite_api.tflite_frontend import TFLiteCompiler
-from femtocrux.femtostack.torch_api.frontend import TorchCompiler
+from femtocrux.server import CompilerFrontend, TorchCompiler
 
 from femtocrux.server.exceptions import format_exception, format_exception_from_exc
 from femtocrux.util.utils import (
-    numpy_to_ndarray,
-    ndarray_to_numpy,
     field_or_none,
     get_channel_options,
+    serialize_simulation_output,
+    deserialize_simulation_data,
 )
 
 # Import GRPC artifacts
 import femtocrux.grpc.compiler_service_pb2 as cs_pb2
 import femtocrux.grpc.compiler_service_pb2_grpc as cs_pb2_grpc
 
+# Set recursion limit to avoid FQIR recursion bug
+sys.setrecursionlimit(10000)
+
 # Network parameters
 default_port = "50051"
 
@@ -49,19 +50,11 @@ class CompileServicer(cs_pb2_grpc.CompileServicer):
             seq_dim=field_or_none(fqir, "sequence_dim"),
         )
 
-    def _get_tflite_compiler(self, model: cs_pb2.model) -> CompilerFrontend:
-        """Get a TFLite compiler from a model message"""
-        tflite = model.tflite
-        return TFLiteCompiler(
-            tflite.model, signature=field_or_none(tflite, "signature_name")
-        )
-
     def _compile_model(self, model: cs_pb2.model, context) -> CompilerFrontend:
         """Compile a model, for simulation or bitfile generation."""
         # Get a compiler for the model
         model_type_map = {
             "fqir": self._get_fqir_compiler,
-            "tflite": self._get_tflite_compiler,
         }
         model_type = model.WhichOneof("ir")
         compiler = model_type_map[model_type](model)
@@ -71,7 +64,7 @@ class CompileServicer(cs_pb2_grpc.CompileServicer):
         if options_struct is None:
             options = {}
         else:
-            options = google.protobuf.json_format.MessageToDict(options_struct)
+            options = MessageToDict(options_struct)
 
         # Compile the model
         compiler.compile(options=options)
@@ -138,28 +131,25 @@ class CompileServicer(cs_pb2_grpc.CompileServicer):
         # Subsequent requests must be data
         for data_request in request_iterator:
             # Check that this is a data message
-            if not data_request.WhichOneof("model_or_data") == "data":
+            if data_request.WhichOneof("model_or_data") not in ["data"]:
                 yield cs_pb2.simulation_output(
                     status=cs_pb2.status(success=False, msg="Expected data message.")
                 )
                 continue
 
-            # Convert input data
-            sim_data = data_request.data
-            data = [ndarray_to_numpy(x) for x in sim_data.data]
-            assert (
-                len(data) == 1
-            ), "Behavioral sim currently only supports 1 input"  # FIXME
-            data = data[0]
+            data = data_request.data
 
             # Simulate the model
             try:
-                outputs, metrics = compiler.run_behavioral_simulator(
-                    data,
-                    quantize_inputs=sim_data.quantize_inputs,
-                    dequantize_outputs=sim_data.dequantize_outputs,
-                    input_period=field_or_none(sim_data, "input_period"),
-                )
+                if data_request.WhichOneof("model_or_data") == "data":
+                    ### New Path with int64 proto message holding data
+                    deserialized_inputs = deserialize_simulation_data(data.inputs)
+                    outputs, metrics = compiler.run_behavioral_simulator(
+                        deserialized_inputs,
+                        input_period=field_or_none(data, "input_period"),
+                    )
+                else:
+                    raise (Exception("Didn't get a model or data"))
             except Exception as exc:
                 msg = "Simulator raised exception:\n%s" % (
                     format_exception_from_exc(exc)
@@ -171,11 +161,8 @@ class CompileServicer(cs_pb2_grpc.CompileServicer):
                 continue
 
             # Respond with output data
-            yield cs_pb2.simulation_output(
-                data=[numpy_to_ndarray(x) for x in outputs],
-                report=metrics,
-                status=cs_pb2.status(success=True),
-            )
+            message = serialize_simulation_output(outputs, metrics)
+            yield message
 
     def version(self, empty, context) -> cs_pb2.version_info:
         """Return the version of femtocrux running in this server."""

femtocrux/util/utils.py

@@ -1,21 +1,12 @@
 """ Utils for client-server communication. """
-
+import json
 import numpy as np
+import torch
 from typing import Any
 
 import femtocrux.grpc.compiler_service_pb2 as cs_pb2
 
 
-def numpy_to_ndarray(data: np.array) -> cs_pb2.ndarray:
-    """Convert a numpy array to an ndarray message."""
-    return cs_pb2.ndarray(data=[float(x) for x in data.ravel()], shape=data.shape)
-
-
-def ndarray_to_numpy(data: cs_pb2.ndarray) -> np.array:
-    """Convert an ndarray message to a numpy array."""
-    return np.array(data.data).reshape(data.shape)
-
-
 def field_or_none(message: Any, field_name: str) -> Any:
     """Convert empty message fields to None."""
     return getattr(message, field_name) if message.HasField(field_name) else None
@@ -29,3 +20,72 @@ def get_channel_options(max_message_mb: int = 32):
         ("grpc.max_send_message_length", max_message_size),
         ("grpc.max_receive_message_length", max_message_size),
     ]
+
+
+def serialize_numpy_array(arr: np.ndarray) -> cs_pb2.ndarray:
+    """Serializes a NumPy array into a NumpyArrayProto message."""
+    return cs_pb2.ndarray(
+        data=arr.tobytes(), shape=list(arr.shape), dtype=str(arr.dtype)
+    )
+
+
+def serialize_sim_inputs_message(
+    data_dict: dict, input_period: float
+) -> cs_pb2.simulation_data:
+    """Serializes a dictionary where values are NumPy arrays."""
+    message = cs_pb2.simulation_data()
+    for key, array in data_dict.items():
+        if isinstance(array, torch.Tensor):
+            array_to_serialize = array.numpy()
+        elif isinstance(array, np.ndarray):
+            array_to_serialize = array
+        else:
+            raise (Exception("Input array was not of type torch.Tensor or np.ndarray"))
+
+        if not np.issubdtype(array_to_serialize.dtype, np.integer):
+            raise (
+                Exception(
+                    "Input data is not an integer type. Please quantize your"
+                    "data to int16 or lower."
+                )
+            )
+
+        if len(array_to_serialize.shape) > 2:
+            raise (
+                Exception(
+                    "Expected 2 dimensions for input and got shape: "
+                    "{array_to_serialize.shape} Your input array has too many "
+                    "dimensions. When in inference mode, please remove any batch "
+                    "dimensions."
+                )
+            )
+
+        message.inputs[key].CopyFrom(serialize_numpy_array(array_to_serialize))
+    message.input_period = input_period
+    return message
+
+
+def serialize_simulation_output(data_dict: dict, report) -> cs_pb2.simulation_output:
+    """Serializes a dictionary where values are NumPy arrays."""
+    message = cs_pb2.simulation_output()
+    for key, array in data_dict.items():
+        message.outputs[key].CopyFrom(serialize_numpy_array(array))
+    message.report = json.dumps(report)
+    message.status.CopyFrom(cs_pb2.status(success=True))
+
+    return message
+
+
+def deserialize_numpy_array(proto: cs_pb2.ndarray) -> np.ndarray:
+    """Deserializes a NumpyArrayProto message back into a NumPy array."""
+    return np.frombuffer(proto.data, dtype=np.dtype(proto.dtype)).reshape(proto.shape)
+
+
+def deserialize_simulation_data(proto: cs_pb2.simulation_data) -> dict:
+    """Deserializes a LargerMessage back into a dictionary of NumPy arrays."""
+    return {key: deserialize_numpy_array(value) for key, value in proto.items()}
+
+
+def deserialize_simulation_output(proto: cs_pb2.simulation_output) -> dict:
+    """Deserializes a LargerMessage back into a dictionary of NumPy arrays."""
+    return {key: deserialize_numpy_array(value) for key, value in proto.items()}

{femtocrux-1.2.1.dist-info → femtocrux-2.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: femtocrux
-Version: 1.2.1
+Version: 2.0.0
 Summary: Femtosense Compiler
 Home-page: https://github.com/femtosense/femtocrux
 Author: Femtosense

femtocrux-2.0.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+femtocrux/ENV_REQUIREMENTS.sh,sha256=t_O1B4hJAMgxvH9gwp1qls6eVFmhSYBJe64KmuK_H-4,1389
+femtocrux/PY_REQUIREMENTS,sha256=UwXV0o3gieruZUYdN9r2bqQ0Wcf_vosjeP6LJVx6oF0,275
+femtocrux/VERSION,sha256=wo_MpTY3vIjhJK8XJd8Ty5jGne3v1i-zzb4c22t2BiQ,6
+femtocrux/__init__.py,sha256=yIWd9I2PEXCn_PKIILAN3mkWeTf0tgtVualeTIHNxfQ,342
+femtocrux/version.py,sha256=uNg2kHxQo6oUN1ah7s9_85rCZVRoTHGPD1GAQPZW4lw,164
+femtocrux/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+femtocrux/client/client.py,sha256=jIkfdIwfTxveC4G-WtQVzumK0m_icdznHFE175P48y0,21601
+femtocrux/grpc/__init__.py,sha256=uiMHQt5I2eAKJqI3Zh0h1Gm7cmPR4PbaGS71nCJQCGw,169
+femtocrux/grpc/compiler_service_pb2.py,sha256=4VbEpkSn7rp1GzBEQq1GPgiuZ8A2CWwgrCupbBvvNmg,5494
+femtocrux/grpc/compiler_service_pb2_grpc.py,sha256=twzBPI2b9BFhkn75WcopLk_Z5D-GwvHheoGOid3gpVA,8501
+femtocrux/server/__init__.py,sha256=kpm2AGLxo3AA9zo-G8N0Dm0gmWbvAd6jfhMbtkeHcxo,77
+femtocrux/server/compiler_frontend.py,sha256=-pfhOHDkXWReoB273Bc9s2s7BVTMZoCSyGM7pudmMhY,5472
+femtocrux/server/exceptions.py,sha256=lI6n471n5QKf5G3aL_1kuBVEItD-jBgithVVpPDwNYc,609
+femtocrux/server/healthcheck.py,sha256=ehqAwnv0D0zpy-AUZAPwv8rp874DZCwUmP8nzdXzZvI,1565
+femtocrux/server/server.py,sha256=sumnTj63uOGkzwj4-xwTuN4wVB7CDopy8e7PLOpW64Q,7405
+femtocrux/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+femtocrux/util/utils.py,sha256=HlmlqS-R7d7PaYaYi8sY6U0p9NoeHjQ1ObapBMKhCrU,3356
+femtocrux-2.0.0.dist-info/licenses/LICENSE,sha256=eN9ZI1xHjUmFvN3TEeop5kBGXRUBfbsl55KBNBYYFqI,36
+femtocrux-2.0.0.dist-info/METADATA,sha256=VH_1bBP3ZdU8y-zSAYW85bwR7fZjXrwFm0mjjJuTW9c,2763
+femtocrux-2.0.0.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+femtocrux-2.0.0.dist-info/top_level.txt,sha256=BkTttlioC3je__8577wxRieZqY3Abu7FOOdMnmYbcNI,10
+femtocrux-2.0.0.dist-info/RECORD,,

{femtocrux-1.2.1.dist-info → femtocrux-2.0.0.dist-info}/WHEEL

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

femtocrux/femtostack/__init__.py

@@ -1,7 +0,0 @@
-def _get_dir():
-    import pathlib
-
-    return pathlib.Path(__file__).parent.parent.resolve()
-
-
-__version__ = (_get_dir() / "VERSION").read_text(encoding="utf-8").strip()

femtocrux/femtostack/common/__init__.py

@@ -1,10 +0,0 @@
-"""
- Copyright Femtosense 2024
- 
- By using this software package, you agree to abide by the terms and conditions
- in the license agreement found at https://femtosense.ai/legal/eula/
-"""
-
-from .frontend import CompilerFrontend  # noqa: F401
-from .metrics import SimMetrics  # noqa: F401
-from .sim_io import IOConfig, SimIOWrapper  # noqa: F401