[WIP] Sonobe integration

.gitignore

@@ -1,10 +1,12 @@
-*.jpg
+.idea/
 */venv/
-circom/*_cpp/
-circom/*_js/
-circom/*.r1cs
-circom/*.sym
-circom/*/*_cpp/
-circom/*/*_js/
-circom/*/*.r1cs
-circom/*/*.sym
+
+input_data/
+runs/
+
+*.json
+
+circuits/**/*_cpp/
+circuits/**/*_js/
+circuits/**/*.r1cs
+circuits/**/*.sym

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Zero Savvy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,90 @@
+.PHONY: help
+help: # Show help for each of the Makefile recipes.
+	@grep -E '^[a-zA-Z0-9 -]+:.*#'  Makefile | sort | while read -r l; do printf "\033[1;32m$$(echo $$l | cut -f 1 -d':')\033[00m:$$(echo $$l | cut -f 2- -d'#')\n"; done
+
+TRANSFORMATIONS = blur brightness contrast crop grayscale hash resize sharpness
+
+########################################################################################################################
+########################### INPUT DATA GENERATION ######################################################################
+########################################################################################################################
+
+INPUT_SOURCE = --image-path ./source_image/HD.png
+INPUT_TARGET_DIR = ./input_data/
+INPUT_TARGET = --output-dir $(INPUT_TARGET_DIR)
+
+EXTRA_ARGS_brightness = --factor 1.4
+EXTRA_ARGS_contrast = --factor 1.4
+EXTRA_ARGS_crop = --x 200 --y 100 --crop-size HD
+EXTRA_ARGS_resize = --resize-option "HD to SD"
+
+.PHONY: generate-input-data
+generate-input-data: # Prepare input data for every supported transformation.
+generate-input-data: $(patsubst %, $(INPUT_TARGET_DIR)%.json, $(TRANSFORMATIONS))
+
+$(INPUT_TARGET_DIR)%.json:
+	@mkdir -p $(INPUT_TARGET_DIR)
+	@python3 image_editor/main.py $* $(INPUT_SOURCE) $(INPUT_TARGET) $(EXTRA_ARGS_$*)
+
+########################################################################################################################
+########################### CIRCUIT COMPILATION ########################################################################
+########################################################################################################################
+
+BACKEND = sonobe nova_snark
+
+COMPILATION_ARTIFACTS := $(foreach backend,$(BACKEND),$(foreach trans,$(TRANSFORMATIONS), \
+    circuits/$(backend)/$(trans)_step.r1cs \
+    circuits/$(backend)/$(trans)_step_js/$(trans)_step.wasm \
+    circuits/$(backend)/$(trans)_step.compile_log))
+
+.PHONY: build-circuits
+build-circuits: $(COMPILATION_ARTIFACTS)
+
+circuits/%_step.r1cs circuits/%_step_js/%_step.wasm circuits/%_step.compile_log: circuits/%_step.circom
+	@backend=$(word 1,$(subst /, ,$*)); \
+	transformation=$(word 2,$(subst /, ,$*)); \
+	transformation_file=$$transformation\_step.circom; \
+	./circuits/build_circuits.sh circuits/$$backend $$transformation_file
+
+.PHONY: report-circuit-parameters
+report-circuit-parameters: build-circuits
+	@python3 analysis_utils/analyze_circuits.py sonobe > /dev/null
+	@python3 analysis_utils/analyze_circuits.py nova_snark > /dev/null
+
+.PHONY: clean-circuits
+clean-circuits:
+	@cd circuits && ./clear_builds.sh sonobe && ./clear_builds.sh nova_snark
+
+########################################################################################################################
+########################### BENCHMARKING ###############################################################################
+########################################################################################################################
+
+RUN_NS_ARTIFACTS := $(foreach trans,$(TRANSFORMATIONS), runs/nova_snark/$(trans).out)
+RUN_SN_ARTIFACTS := $(foreach trans,$(TRANSFORMATIONS), runs/sonobe/$(trans).out)
+NS_REPORT_FILE = runs/nova_snark_report.txt
+SN_REPORT_FILE = runs/sonobe_report.txt
+
+.PHONY: run-nova-snark-benchmarks
+run-nova-snark-benchmarks: generate-input-data build-circuits $(RUN_NS_ARTIFACTS)
+	@$(call generate-report,$(RUN_NS_ARTIFACTS),$(NS_REPORT_FILE))
+
+runs/nova_snark/%.out:
+	@mkdir -p runs/nova_snark
+	@cd vimz/ && $(MAKE) $* BACKEND=nova-snark DEMO=yes > ../$@
+
+.PHONY: run-sonobe-benchmarks
+run-sonobe-benchmarks: generate-input-data build-circuits $(RUN_SN_ARTIFACTS)
+	@$(call generate-report,$(RUN_SN_ARTIFACTS),$(SN_REPORT_FILE))
+
+runs/sonobe/%.out:
+	@mkdir -p runs/sonobe
+	@cd vimz/ && $(MAKE) $* BACKEND=sonobe DEMO=yes LIGHT_TEST=yes > ../$@
+
+define generate-report
+	> $2
+	for log in $1; do \
+		func=$$(grep -m1 "Selected function:" $$log | sed -E 's/.*Selected function: (.*)/\1/'); \
+		fold_time=$$(grep "Fold input" $$log | grep -v "completed" | awk '{print $$NF}' | tail -n1); \
+		echo "$$func: $$fold_time" >> $2; \
+	done
+	echo "Report saved to $2"
+endef

README.md

@@ -85,7 +85,7 @@ build node modules:
 
 build ZK circuits using the provided script in this directory:
 
-`./build-circuits.sh`
+`./build_circuits.sh`
 
 ## How to Use
 

analysis_utils/analyze_circuits.py

@@ -0,0 +1,44 @@
+import sys
+
+import pandas as pd
+from tabulate import tabulate
+
+parameters = [
+    "Template Instances", "Non-Linear Constraints", "Linear Constraints",
+    "Public Inputs", "Private Inputs", "Public Outputs", "Wires", "Labels"
+]
+
+
+def parse_logs_to_dataframe(log_files):
+    data = []
+    for log_file in log_files:
+        base_name = log_file.split("/")[-1].removesuffix("_step.compile_log")
+        with open(log_file, 'r') as f:
+            content = f.readlines()
+            metrics = {"File Name": base_name} | {key: 0 for key in parameters}
+            for line in content:
+                for key in metrics.keys():
+                    if key.lower() in line.lower():
+                        metrics[key] = int(line.split(":")[1].strip().split(" ")[0])
+            data.append(metrics)
+    return pd.DataFrame(data)
+
+
+def gather_circuit_parameters(backend):
+    transformations = ["blur", "brightness", "contrast", "crop", "grayscale", "hash", "resize", "sharpness"]
+    files = [f"circuits/{backend}/{t}_step.compile_log" for t in transformations]
+    return parse_logs_to_dataframe(files)
+
+
+if __name__ == '__main__':
+    if len(sys.argv) != 2:
+        raise ValueError("Invalid number of arguments. Usage: python analyze_circuits.py <backend>")
+    backend = sys.argv[1]
+
+    if backend not in ["nova_snark", "sonobe"]:
+        raise ValueError("Invalid backend. Must be either 'nova_snark' or 'sonobe'.")
+
+    parameters = gather_circuit_parameters(backend)
+
+    print(tabulate(parameters, headers="keys", tablefmt="grid"))
+    parameters.to_csv(f"circuits/{backend}/circuit_parameters.csv", index=False)

analysis_utils/compare_circuits.py

@@ -0,0 +1,21 @@
+import sys
+
+import pandas as pd
+from tabulate import tabulate
+
+from analyze_circuits import parameters
+
+if __name__ == '__main__':
+    if len(sys.argv) != 3:
+        raise ValueError("Invalid number of arguments. Usage: python compare_circuits.py <param_file_1> <param_file_2>")
+    params_1, params_2 = pd.read_csv(sys.argv[1]), pd.read_csv(sys.argv[2])
+
+    comparison = pd.merge(params_1, params_2, on="File Name", suffixes=("_1", "_2"))
+
+    for col in parameters:
+        comparison[f"{col} Diff"] = comparison[f"{col}_1"] - comparison[f"{col}_2"]
+
+    diff_columns = ["File Name"] + [f"{col} Diff" for col in parameters]
+    diff_table = comparison[diff_columns]
+
+    print(tabulate(diff_table, headers="keys", tablefmt="grid"))

analysis_utils/requirements.txt

@@ -0,0 +1,2 @@
+pandas==2.2.3
+tabulate==0.9.0

circuits/build_circuits.sh

@@ -1,52 +1,48 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-# Set the directory where you want to search for files
-target_directory="."
+set -eou pipefail
 
-# Set the pattern of files you want to process
+# Display usage instructions
+usage() {
+  echo "Usage: $0 <subfolder> [specific_circuit_file]"
+  echo " - <subfolder>: Required. The subfolder containing the circuit files."
+  echo " - [specific_circuit_file]: Optional. A specific .circom file to rebuild."
+  exit 1
+}
+
+# Validate arguments
+if [ "$#" -lt 1 ]; then
+  usage
+fi
+
+# Assign the first argument as the subfolder name
+subfolder="$1"
+
+# Navigate to the subfolder
+cd "$subfolder" || exit
+
+# Set the pattern for files to process
 file_pattern="*.circom"
 
+# Enable nullglob to avoid issues with empty file lists
 shopt -s nullglob
 
-# If an argument is provided, use it as the specific file
-if [ "$#" -eq 1 ]; then
-    user_provided_file="$1"
-    # Check if the provided file exists
-    if [ -f "$user_provided_file" ]; then
-        file_list=("$user_provided_file")
-    else
-        echo "Error: Provided file '$user_provided_file' not found."
-        exit 1
-    fi
+# Determine files to process
+if [ "$#" -eq 2 ]; then
+  specific_file="$2"
+  if [ -f "$specific_file" ]; then
+    file_list=("$specific_file")
+  else
+    echo "Error: File '$specific_file' not found."
+    exit 1
+  fi
 else
-    # If no argument is provided, use pattern-matching
-    file_list=($target_directory/$file_pattern)
+    file_list=($file_pattern)
 fi
 
-# Iterate over files matching the pattern and run commands
+# Iterate over and process each file
 for file in "${file_list[@]}"; do
-    # echo "$file"
-    if [ -f "$file" ]; then
-        echo " "
-        echo -e "\033[1;34m==================================================\033[0m"
-        echo -e "\033[1;34mProcessing file: $file\033[0m"
-        echo -e "\033[1;34m==================================================\033[0m"
-
-        # Start timing
-        start_time=$(date +%s.%N)
-
-        circom $file --r1cs --wasm --sym --c --prime vesta
-        filename=$(basename -- "$file")
-        filename_no_extension="${filename%.*}"
-        cpp_directory="${filename_no_extension}_cpp"
-        js_directory="${filename_no_extension}_js"
-        (
-            cd "$cpp_directory" || exit
-            echo -e "\033[1;32mRunning make in $cpp_directory\033[0m"
-            make
-        )
-        end_time=$(date +%s.%N)
-        elapsed_time=$(echo "$end_time - $start_time" | bc)
-        echo -e "\033[1;34mTime taken: $elapsed_time seconds\033[0m"
-    fi
+  echo -e "\033[1mBuilding circuit: ${file}\033[0m"
+  base_name=$(basename "$file" .circom)
+  circom "$file" --O2 --r1cs --wasm > "${base_name}.compile_log"
 done

circuits/clear_builds.sh

@@ -1,22 +1,79 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-# Set the directory where you want to search for folders
-target_directory="."
+set -eou pipefail
 
-# Set the patterns of folders you want to remove
-folder_patterns=( )
+# Display usage instructions
+usage() {
+    echo "Usage: $0 <subfolder> [specific_circuit_file]"
+    echo " - <subfolder>: Required. The subfolder containing the circuit files to clean."
+    echo " - [specific_circuit_file]: Optional. A specific circuit to clean related files for."
+    exit 1
+}
 
+# Validate arguments
+if [ "$#" -lt 1 ]; then
+    usage
+fi
+
+# Assign the first argument as the subfolder name
+subfolder="$1"
+
+# Validate the provided subfolder
+if [ ! -d "$subfolder" ]; then
+    echo "Error: Subfolder '$subfolder' not found."
+    exit 1
+fi
+
+# Navigate to the subfolder
+cd "$subfolder" || exit
+
+# Define patterns for cleanup
 folder_patterns=("*_js" "*_cpp")
 file_patterns=("*.r1cs" "*.sym")
 
-# Use find to locate and remove folders matching the patterns
+# If a specific circuit file is provided
+if [ "$#" -eq 2 ]; then
+    specific_file="$2"
+    if [ -f "$specific_file" ]; then
+        # Extract the base name (without extension)
+        base_name=$(basename "$specific_file" .circom)
+        folder_patterns=("${base_name}_js" "${base_name}_cpp")
+        file_patterns=("${base_name}.r1cs" "${base_name}.sym")
+    else
+        echo "Error: Specific circuit file '$specific_file' not found."
+        exit 1
+    fi
+fi
+
+# Function to remove folders matching patterns
+remove_folders() {
+    local pattern="$1"
+    matching_folders=$(find . -type d -name "$pattern")
+    if [ -n "$matching_folders" ]; then
+        find . -type d -name "$pattern" -exec rm -r {} +
+        echo "Folders matching the pattern '$pattern' removed."
+    else
+        echo "No folders matching the pattern '$pattern' found."
+    fi
+}
+
+# Function to remove files matching patterns
+remove_files() {
+    local pattern="$1"
+    matching_files=$(find . -type f -name "$pattern")
+    if [ -n "$matching_files" ]; then
+        find . -type f -name "$pattern" -exec rm {} +
+        echo "Files matching the pattern '$pattern' removed."
+    else
+        echo "No files matching the pattern '$pattern' found."
+    fi
+}
+
+# Perform cleanup
 for pattern in "${folder_patterns[@]}"; do
-    find "$target_directory" -type d -name "$pattern" -exec rm -r {} +
-    echo "Folders matching the pattern '$pattern' removed."
+    remove_folders "$pattern"
 done
 
-# Use find to locate and remove files matching the patterns
 for pattern in "${file_patterns[@]}"; do
-    find "$target_directory" -type f -name "$pattern" -exec rm {} +
-    echo "Files matching the pattern '$pattern' removed."
-done
+    remove_files "$pattern"
+done