Bugfix/type safety

examples/README.md

@@ -7,7 +7,12 @@ The following are the currently available examples:
 - [Complex Model](./complex_model): shows how to build more intricate model architectures using Nada AI. Contains convolutions, pooling operations, linear layers and activations
 - [Time Series](./time_series): shows how to run a Facebook Prophet time series forecasting model using Nada AI
 - [Spam Detection Demo](./spam_detection): shows how to build a privacy-preserving spam detection model using Nada AI. Contains Logistic Regression, and cleartext TF-IDF vectorization.
+- [Multi layer Perceptron Demo](./multi_layer_perceptron): shows how to build a privacy-preserving medical image classification model using Nada AI. Features Convolutional Neural Network logic.
 
-The Nada program source code is stored in `src/<EXAMPLE_NAME>.py`.
+In order to run an example, simply:
+1. Navigate to the example folder `cd <EXAMPLE_NAME>`
+2. Build the program via `nada build`
+3. (Optional) Test the program via `nada test`
+4. Run the example / demo. This will either be a Python script you can run via `python3 main.py` or a Jupyter notebook where you can just run the cells.
 
-In order to follow the end-to-end example, head to `network/compute.py`. You can run it by simply running `nada build` to build the Nada program followed by `python network/compute.py`.
+The Nada program source code is stored in `src/<EXAMPLE_NAME>.py`.

examples/complex_model/README.md

@@ -0,0 +1,11 @@
+# Complex model
+
+This example shows how you can build and run an arbitrarily complex AI model - much like you can in PyTorch!
+
+The model architecture is defined in `src/my_model.py`. You will notice that it is syntactically nearly identical to the equivalent PyTorch model.
+
+This model is then used in the main Nada program - defined in `src/complex_model.py`. What this script does is simply:
+- Load the model provided by Party0 via `my_model = MyModel()` and `my_model.load_state_from_network("my_model", parties[0], na.SecretRational)`
+- Load in the (3, 4, 3) input data matrix called "my_input" provided by Party1 via `na.array((3, 4, 3), parties[1], "my_input", na.SecretRational)`
+- Run inference via `result = my_model(my_input)` 
+- Return the inference result to Party1 via `return result.output(parties[1], "my_output")`

examples/complex_model/network/compute.py → examples/complex_model/main.py

@@ -1,24 +1,19 @@
 import asyncio
 import os
-import sys
 import time
 
 import nada_algebra as na
+import nada_algebra.client as na_client
 import numpy as np
 import py_nillion_client as nillion
 import torch
 from dotenv import load_dotenv
-
-from nada_ai.client import TorchClient
-
-# Add the parent directory to the system path to import modules from it
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "../..")))
-
-import nada_algebra.client as na_client
 # Import helper functions for creating nillion client and getting keys
 from nillion_python_helpers import (create_nillion_client, getNodeKeyFromFile,
                                     getUserKeyFromFile)
 
+from nada_ai.client import TorchClient
+
 # Load environment variables from a .env file
 load_dotenv()
 
@@ -94,7 +89,7 @@ async def main():
     party_id = client.party_id
     user_id = client.user_id
     party_names = na_client.parties(2)
-    program_name = "main"
+    program_name = "complex_model"
     program_mir_path = f"./target/{program_name}.nada.bin"
 
     if not os.path.exists("bench"):

examples/complex_model/src/my_model.py

@@ -8,6 +8,7 @@ class MyConvModule(nn.Module):
 
     def __init__(self) -> None:
         """Contains some ConvNet components"""
+        super().__init__()
         self.conv = nn.Conv2d(kernel_size=2, in_channels=3, out_channels=2)
         self.pool = nn.AvgPool2d(kernel_size=2, stride=1)
 
@@ -29,6 +30,7 @@ class MyModel(nn.Module):
 
     def __init__(self) -> None:
         """Model is a collection of arbitrary custom components"""
+        super().__init__()
         self.conv_module = MyConvModule()
         self.my_operations = MyOperations()
         self.linear = nn.Linear(4, 2)

examples/linear_regression/README.md

@@ -0,0 +1,11 @@
+# Linear regression
+
+This example shows how you can run a linear regression model using Nada AI. It highlights that, although there exists a major parallel between Nada AI's design and that of PyTorch, it also integrates with other frameworks such as in this case `sci-kitlearn`
+
+You will find the nada program in `src/linear_regression.py`
+
+What this script does is simply:
+- Load the model provided by Party0 via `my_model = LinearRegression(in_features=10)` and `my_model.load_state_from_network("my_model", parties[0], na.SecretRational)`
+- Load in the 10 input features as a 1-d array called "my_input" provided by Party1 via `my_input = na.array((10,), parties[1], "my_input", na.SecretRational)`
+- Run inference via `result = my_model.forward(my_input)` 
+- Return the inference result to Party1 via `return [Output(result.value, "my_output", parties[1])]`

examples/linear_regression/network/compute.py → examples/linear_regression/main.py

@@ -1,23 +1,18 @@
 import asyncio
 import os
-import sys
 import time
 
 import nada_algebra as na
+import nada_algebra.client as na_client
 import numpy as np
 import py_nillion_client as nillion
 from dotenv import load_dotenv
-from sklearn.linear_model import LinearRegression
-
-from nada_ai.client import SklearnClient
-
-# Add the parent directory to the system path to import modules from it
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "../..")))
-
-import nada_algebra.client as na_client
 # Import helper functions for creating nillion client and getting keys
 from nillion_python_helpers import (create_nillion_client, getNodeKeyFromFile,
                                     getUserKeyFromFile)
+from sklearn.linear_model import LinearRegression
+
+from nada_ai.client import SklearnClient
 
 # Load environment variables from a .env file
 load_dotenv()
@@ -96,7 +91,7 @@ async def main():
     party_id = client.party_id
     user_id = client.user_id
     party_names = na_client.parties(2)
-    program_name = "main"
+    program_name = "linear_regression"
     program_mir_path = f"./target/{program_name}.nada.bin"
 
     if not os.path.exists("bench"):
@@ -162,7 +157,7 @@ async def main():
         nillion.Secrets({}),
     )
     # Rescale the obtained result by the quantization scale
-    outputs = [na_client.float_from_rational(result["my_output_0"])]
+    outputs = [na_client.float_from_rational(result["my_output"])]
     print(f"🖥️  The result is {outputs}")
 
     expected = fit_model.predict(np.ones((NUM_FEATS,)).reshape(1, -1))

examples/linear_regression/src/linear_regression.py

@@ -1,4 +1,5 @@
 import nada_algebra as na
+from nada_dsl import Output
 
 from nada_ai.linear_model import LinearRegression
 
@@ -8,7 +9,7 @@ def nada_main():
     parties = na.parties(2)
 
     # Step 2: Instantiate linear regression object
-    my_model = LinearRegression(10)
+    my_model = LinearRegression(in_features=10)
 
     # Step 3: Load model weights from Nillion network by passing model name (acts as ID)
     # In this examples Party0 provides the model and Party1 runs inference
@@ -22,4 +23,4 @@ def nada_main():
     result = my_model.forward(my_input)
 
     # Step 6: We can use result.output() to produce the output for Party1 and variable name "my_output"
-    return result.output(parties[1], "my_output")
+    return [Output(result.value, "my_output", parties[1])]

examples/linear_regression/tests/linear_regression.yaml

@@ -53,6 +53,6 @@ inputs:
   public_variables: {}
 expected_outputs:
   # If you go in and crunch the numbers of this one, the result should be 16.877471923828125
-  # 16.877471923828125 * 2**16 = 1106082
-  my_output_0:
-    SecretInteger: "1106082"
+  # 16.877471923828125 * 2**16 = 1106085
+  my_output:
+    SecretInteger: "1106085"

examples/multi_layer_perceptron/01_model_provider.ipynb

@@ -615,8 +615,8 @@
     "    Returns:\n",
     "        Dict[str, str]: Resulting `action_id` and `program_id`.\n",
     "    \"\"\"\n",
-    "    action_id = await client.store_program(cluster_id, \"main\", nada_program_path)\n",
-    "    program_id = f\"{user_id}/main\"\n",
+    "    action_id = await client.store_program(cluster_id, \"multi_layer_perceptron\", nada_program_path)\n",
+    "    program_id = f\"{user_id}/multi_layer_perceptron\"\n",
     "\n",
     "    return {\n",
     "        \"action_id\": action_id,\n",
@@ -644,7 +644,7 @@
     "    client=model_provider_client,\n",
     "    cluster_id=cluster_id,\n",
     "    user_id=model_provider_user_id,\n",
-    "    nada_program_path=\"target/main.nada.bin\",\n",
+    "    nada_program_path=\"target/multi_layer_perceptron.nada.bin\",\n",
     ")\n",
     "\n",
     "action_id = result_store_program[\"action_id\"]\n",
@@ -804,7 +804,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.3"
+   "version": "3.12.2"
   }
  },
  "nbformat": 4,

examples/multi_layer_perceptron/README.md

@@ -1,8 +1,6 @@
 # Multi-Layer Perceptron Demo
-**This folder was generated using `nada init`**
 
-To execute this tutorial, you may potentially need to install the `requirements.txt` apart from nada-ai:
+To execute this tutorial, you may need to install the `requirements.txt`:
 ```bash
 pip install -r requirements.txt
 ```
-

examples/multi_layer_perceptron/nada-project.toml

@@ -1,7 +1,7 @@
-name = "text_classification"
+name = "multi_layer_perceptron"
 version = "0.1.0"
 authors = [""]
 
 [[programs]]
-path = "src/main.py"
+path = "src/multi_layer_perceptron.py"
 prime_size = 128

examples/multi_layer_perceptron/src/main.py → examples/multi_layer_perceptron/src/multi_layer_perceptron.py

@@ -1,5 +1,3 @@
-"""MLP Nada program"""
-
 import nada_algebra as na
 from my_nn import MyNN
 

examples/multi_layer_perceptron/src/my_nn.py

@@ -8,6 +8,7 @@ class MyNN(nn.Module):
 
     def __init__(self) -> None:
         """Model is a two layers and an activations"""
+        super(MyNN, self).__init__()
         # Input size (1, 1, 16, 16) --> Output size (1, 2)
         self.conv1 = nn.Conv2d(
             in_channels=1, out_channels=2, kernel_size=3, padding=1, stride=4

examples/multi_layer_perceptron/target/.gitignore

@@ -0,0 +1,5 @@
+# This directory is kept purposely, so that no compilation errors arise.
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore