femtocrux 0.7.1__py3-none-any.whl → 0.8.0__py3-none-any.whl

femtocrux/VERSION

@@ -1 +1 @@
-0.7.1
+0.8.0

femtocrux/grpc/compiler_service_pb2.py

@@ -2,7 +2,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # NO CHECKED-IN PROTOBUF GENCODE
 # source: compiler_service.proto
-# Protobuf Python Version: 5.27.2
+# Protobuf Python Version: 5.28.1
 """Generated protocol buffer code."""
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
@@ -12,8 +12,8 @@ from google.protobuf.internal import builder as _builder
 _runtime_version.ValidateProtobufRuntimeVersion(
     _runtime_version.Domain.PUBLIC,
     5,
-    27,
-    2,
+    28,
+    1,
     '',
     'compiler_service.proto'
 )

femtocrux/grpc/compiler_service_pb2_grpc.py

@@ -6,7 +6,7 @@ import warnings
 import compiler_service_pb2 as compiler__service__pb2
 from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2
 
-GRPC_GENERATED_VERSION = '1.67.0'
+GRPC_GENERATED_VERSION = '1.68.0'
 GRPC_VERSION = grpc.__version__
 _version_not_supported = False
 

{femtocrux-0.7.1.dist-info → femtocrux-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: femtocrux
-Version: 0.7.1
+Version: 0.8.0
 Summary: Femtosense Compiler
 Home-page: https://github.com/femtosense/femtocrux
 Author: Femtosense
@@ -40,6 +40,9 @@ Supported ML model representations:
 
 ## Installation
 
+You will need to install `femtocrux` and `femtodriver` to compile models to run on the SPU and to run simulations to
+get power metrics.
+
 You will need to have python `3.10` and Docker installed.
 Install Docker by following [these instructions](https://docs.docker.com/get-docker/).
 
@@ -49,53 +52,17 @@ femtocrux is available on PyPI via
 pip install femtocrux
 ```
 
-## Basic Usage
-
-### `ManagedCompilerClient`
-`ManagedCompilerClient` is the recommended way to use femtocrux within a context manager.
-
-```python
-from femtocrux import ManagedCompilerClient, FQIRModel
-
-# fqir_graph = ... # Assuming we have an FQIR graph using fmot
-# inputs = ...     # Assuming we have numpy array inputs to the model
-
-fqir_model = FQIRModel(fqir_graph, batch_dim=0, sequence_dim=1)
-with ManagedCompilerClient() as client:
-    
-    # simulate execution, view power, energy, and latency metrics
-    simulator = client.simulate(fqir_model)
-    outputs, metrics = simulator.simulate(inputs)
+femtodriver is also available on PyPI via
 
-    # compile the model to a bitfile
-    bitstream = client.compile(fqir_model)
-    with open('my_bitfile.zip', 'wb') as f: 
-        f.write(bitstream)
+```
+pip install femtodriver
 ```
 
-The bitfile can be used to generate program files to run on the SPU, using [femtodriverpub](https://github.com/femtosense/femtodriverpub.git)
-
-### `CompilerClient`
-`CompilerClient` is another interface to the compiler. This will be deprecated in future releases, so we recommend using `ManagedCompilerClient`.
-
-```python
-from femtocrux import CompilerClient, FQIRModel
-
-# fqir_graph = ... # Assuming we have an FQIR graph using fmot
-# inputs = ...     # Assuming we have numpy array inputs to the model
-
-fqir_model = FQIRModel(fqir_graph, batch_dim=0, sequence_dim=1)
-client = CompilerClient()
-    
-# simulate execution, view power, energy, and latency metrics
-simulator = client.simulate(fqir_model)
-outputs, metrics = simulator.simulate(inputs)
+## Usage
 
-# compile the model to a bitfile
-bitstream = client.compile(fqir_model)
-with open('my_bitfile.zip', 'wb') as f: 
-    f.write(bitstream)
+Please refer to the documentation in the [e2e walkthrough](https://femtocrux.femtosense.ai/en/latest/e2e_example/e2e_example.html) for a full example of how to create a model in pytorch, use femtodriver to compile program files
+to run on the SPU, and for how to run simulations of the model to get power estimates.
 
-# close the client (important to avoid background docker containers that continue running)
-client.close()
+If you want more detailed documentation of all the options you can use to compile and simulate with please refer to
+the [femtodriver documentation](https://pypi.org/project/femtodriver/).
 ```

{femtocrux-0.7.1.dist-info → femtocrux-0.8.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 femtocrux/ENV_REQUIREMENTS.sh,sha256=t_O1B4hJAMgxvH9gwp1qls6eVFmhSYBJe64KmuK_H-4,1389
 femtocrux/PY_REQUIREMENTS,sha256=wvbsR34rwqytCWDCFxBubN9d5tkUkr1ocfJVjS6nwH0,283
-femtocrux/VERSION,sha256=kCMRx7s4-hZY_0A972FY7nN4_p1uLihPocOHNcMb0ws,6
+femtocrux/VERSION,sha256=pmeA2iMQO-rxJDK0GFCJZrMaKjp4f5RopbbNqoZnwe8,6
 femtocrux/__init__.py,sha256=yIWd9I2PEXCn_PKIILAN3mkWeTf0tgtVualeTIHNxfQ,342
 femtocrux/version.py,sha256=uNg2kHxQo6oUN1ah7s9_85rCZVRoTHGPD1GAQPZW4lw,164
 femtocrux/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -15,16 +15,16 @@ femtocrux/femtostack/tflite_api/tflite_frontend.py,sha256=CsvurJ2RJPnUgjfwQ8ru6j
 femtocrux/femtostack/torch_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 femtocrux/femtostack/torch_api/frontend.py,sha256=-12zz0NpvQgpPNqBMg7EJQdomtRJPNffrVKC6rBqfBE,4064
 femtocrux/grpc/__init__.py,sha256=uiMHQt5I2eAKJqI3Zh0h1Gm7cmPR4PbaGS71nCJQCGw,169
-femtocrux/grpc/compiler_service_pb2.py,sha256=E2Yl97eENjTeP5n_O1y2qDHOCUfPCFxNWSBdupdkmhg,4703
-femtocrux/grpc/compiler_service_pb2_grpc.py,sha256=N0h2BjL2Vh20q3vNu_I7BGDG8QIY79_9hnjrpGaBovw,8501
+femtocrux/grpc/compiler_service_pb2.py,sha256=CQM23zxPQPocdekXSb1nSetgdkwt4ji067X9BU9ICao,4703
+femtocrux/grpc/compiler_service_pb2_grpc.py,sha256=G51LUdb34R4IAFjRx8-Ti0wEG4QhsEVjcrHdDmxSS_s,8501
 femtocrux/server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 femtocrux/server/exceptions.py,sha256=lI6n471n5QKf5G3aL_1kuBVEItD-jBgithVVpPDwNYc,609
 femtocrux/server/healthcheck.py,sha256=ehqAwnv0D0zpy-AUZAPwv8rp874DZCwUmP8nzdXzZvI,1565
 femtocrux/server/server.py,sha256=fpwL1GtFvdw7E0inkMDbDKd-Hu3QAuEgvlqFP7vtZhY,7928
 femtocrux/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 femtocrux/util/utils.py,sha256=FZ8cssDom4B3FDbVU_ew4Cf3wOWjo2w1jwcbnLzoYnM,1003
-femtocrux-0.7.1.dist-info/LICENSE,sha256=eN9ZI1xHjUmFvN3TEeop5kBGXRUBfbsl55KBNBYYFqI,36
-femtocrux-0.7.1.dist-info/METADATA,sha256=ywFcbvCSCYV42vqzqI9cHgwONmqSuxSaUtRquZw5jEE,3556
-femtocrux-0.7.1.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-femtocrux-0.7.1.dist-info/top_level.txt,sha256=BkTttlioC3je__8577wxRieZqY3Abu7FOOdMnmYbcNI,10
-femtocrux-0.7.1.dist-info/RECORD,,
+femtocrux-0.8.0.dist-info/LICENSE,sha256=eN9ZI1xHjUmFvN3TEeop5kBGXRUBfbsl55KBNBYYFqI,36
+femtocrux-0.8.0.dist-info/METADATA,sha256=LYOOgHsNDrpnuc_9Y4vlf7TEfb2sVCxvcNcEuniiG-U,2530
+femtocrux-0.8.0.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+femtocrux-0.8.0.dist-info/top_level.txt,sha256=BkTttlioC3je__8577wxRieZqY3Abu7FOOdMnmYbcNI,10
+femtocrux-0.8.0.dist-info/RECORD,,

{femtocrux-0.7.1.dist-info → femtocrux-0.8.0.dist-info}/WHEEL

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