ci: update version string in docs

docs/python/src/conf.py

@@ -1,7 +1,7 @@
 import ezkl
 
 project = 'ezkl'
-release = '0.0.0'
+release = '22.1.4'
 version = release
 
 

src/execute.rs

@@ -1266,7 +1266,8 @@ pub(crate) fn calibrate(
                 num_rows: new_settings.num_rows,
                 total_assignments: new_settings.total_assignments,
                 total_const_size: new_settings.total_const_size,
-                total_dynamic_col_size: new_settings.total_dynamic_col_size,
+                dynamic_lookup_params: new_settings.dynamic_lookup_params,
+                shuffle_params: new_settings.shuffle_params,
                 ..settings.clone()
             };
 

src/graph/mod.rs

@@ -413,6 +413,27 @@ fn insert_polycommit_pydict(
     Ok(())
 }
 
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
+/// Parameters for dynamic lookups
+/// serde should flatten this struct
+pub struct DynamicLookupParams {
+    /// total dynamic column size
+    pub total_dynamic_col_size: usize,
+    /// max dynamic column input length
+    pub max_dynamic_input_len: usize,
+    /// number of dynamic lookups
+    pub num_dynamic_lookups: usize,
+}
+
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
+/// Parameters for shuffle operations
+pub struct ShuffleParams {
+    /// number of shuffles
+    pub num_shuffles: usize,
+    /// total shuffle column size
+    pub total_shuffle_col_size: usize,
+}
+
 /// model parameters
 #[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
 pub struct GraphSettings {
@@ -424,16 +445,12 @@ pub struct GraphSettings {
     pub total_assignments: usize,
     /// total const size
     pub total_const_size: usize,
-    /// total dynamic column size
-    pub total_dynamic_col_size: usize,
-    /// max dynamic column input length
-    pub max_dynamic_input_len: usize,
-    /// number of dynamic lookups
-    pub num_dynamic_lookups: usize,
-    /// number of shuffles
-    pub num_shuffles: usize,
-    /// total shuffle column size
-    pub total_shuffle_col_size: usize,
+    /// dynamic lookup parameters, flattened for backwards compatibility
+    #[serde(flatten)]
+    pub dynamic_lookup_params: DynamicLookupParams,
+    /// shuffle parameters, flattened for backwards compatibility
+    #[serde(flatten)]
+    pub shuffle_params: ShuffleParams,
     /// the shape of public inputs to the model (in order of appearance)
     pub model_instance_shapes: Vec<Vec<usize>>,
     /// model output scales
@@ -495,15 +512,16 @@ impl GraphSettings {
     }
 
     fn dynamic_lookup_and_shuffle_logrows(&self) -> u32 {
-        (self.total_dynamic_col_size as f64 + self.total_shuffle_col_size as f64)
+        (self.dynamic_lookup_params.total_dynamic_col_size as f64
+            + self.shuffle_params.total_shuffle_col_size as f64)
             .log2()
             .ceil() as u32
     }
 
     /// calculate the number of rows required for the dynamic lookup and shuffle
     pub fn dynamic_lookup_and_shuffle_logrows_with_blinding(&self) -> u32 {
-        (self.total_dynamic_col_size as f64
-            + self.total_shuffle_col_size as f64
+        (self.dynamic_lookup_params.total_dynamic_col_size as f64
+            + self.shuffle_params.total_shuffle_col_size as f64
             + RESERVED_BLINDING_ROWS as f64)
             .log2()
             .ceil() as u32
@@ -511,13 +529,14 @@ impl GraphSettings {
 
     /// calculate the number of rows required for the dynamic lookup and shuffle
     pub fn min_dynamic_lookup_and_shuffle_logrows_with_blinding(&self) -> u32 {
-        (self.max_dynamic_input_len as f64 + RESERVED_BLINDING_ROWS as f64)
+        (self.dynamic_lookup_params.max_dynamic_input_len as f64 + RESERVED_BLINDING_ROWS as f64)
             .log2()
             .ceil() as u32
     }
 
     fn dynamic_lookup_and_shuffle_col_size(&self) -> usize {
-        self.total_dynamic_col_size + self.total_shuffle_col_size
+        self.dynamic_lookup_params.total_dynamic_col_size
+            + self.shuffle_params.total_shuffle_col_size
     }
 
     /// calculate the number of rows required for the module constraints
@@ -653,12 +672,12 @@ impl GraphSettings {
 
     /// requires dynamic lookup
     pub fn requires_dynamic_lookup(&self) -> bool {
-        self.num_dynamic_lookups > 0
+        self.dynamic_lookup_params.num_dynamic_lookups > 0
     }
 
     /// requires dynamic shuffle
     pub fn requires_shuffle(&self) -> bool {
-        self.num_shuffles > 0
+        self.shuffle_params.num_shuffles > 0
     }
 
     /// any kzg visibility

src/graph/model.rs

@@ -12,6 +12,8 @@ use crate::circuit::Input;
 use crate::circuit::InputType;
 use crate::circuit::Unknown;
 use crate::fieldutils::IntegerRep;
+use crate::graph::DynamicLookupParams;
+use crate::graph::ShuffleParams;
 use crate::tensor::ValType;
 use crate::{
     circuit::{lookup::LookupOp, BaseConfig as PolyConfig, CheckMode, Op},
@@ -100,12 +102,10 @@ pub type NodeGraph = BTreeMap<usize, NodeType>;
 pub struct DummyPassRes {
     /// number of rows use
     pub num_rows: usize,
-    /// num dynamic lookups
-    pub num_dynamic_lookups: usize,
-    /// max dynamic lookup input len
-    pub max_dynamic_input_len: usize,
-    /// dynamic lookup col size
-    pub dynamic_lookup_col_coord: usize,
+    /// dynamic lookup parameters
+    pub dynamic_lookup_params: DynamicLookupParams,
+    /// shuffle parameters
+    pub shuffle_params: ShuffleParams,
     /// num shuffles
     pub num_shuffles: usize,
     /// shuffle
@@ -585,16 +585,13 @@ impl Model {
             num_rows: res.num_rows,
             total_assignments: res.linear_coord,
             required_lookups: res.lookup_ops.into_iter().collect(),
-            max_dynamic_input_len: res.max_dynamic_input_len,
             required_range_checks: res.range_checks.into_iter().collect(),
             model_output_scales: self.graph.get_output_scales()?,
             model_input_scales: self.graph.get_input_scales(),
             input_types: self.get_input_types().ok(),
             output_types: Some(self.get_output_types()),
-            num_dynamic_lookups: res.num_dynamic_lookups,
-            total_dynamic_col_size: res.dynamic_lookup_col_coord,
-            num_shuffles: res.num_shuffles,
-            total_shuffle_col_size: res.shuffle_col_coord,
+            dynamic_lookup_params: res.dynamic_lookup_params,
+            shuffle_params: res.shuffle_params,
             total_const_size: res.total_const_size,
             check_mode,
             version: env!("CARGO_PKG_VERSION").to_string(),
@@ -1523,15 +1520,21 @@ impl Model {
         let res = DummyPassRes {
             num_rows: region.row(),
             linear_coord: region.linear_coord(),
-            max_dynamic_input_len: region.max_dynamic_input_len(),
+            dynamic_lookup_params: DynamicLookupParams {
+                total_dynamic_col_size: region.dynamic_lookup_col_coord(),
+                max_dynamic_input_len: region.max_dynamic_input_len(),
+                num_dynamic_lookups: region.dynamic_lookup_index(),
+            },
+            shuffle_params: ShuffleParams {
+                num_shuffles: region.shuffle_index(),
+                total_shuffle_col_size: region.shuffle_col_coord(),
+            },
             total_const_size: region.total_constants(),
             lookup_ops: region.used_lookups(),
             range_checks: region.used_range_checks(),
             max_lookup_inputs: region.max_lookup_inputs(),
             min_lookup_inputs: region.min_lookup_inputs(),
             max_range_size: region.max_range_size(),
-            num_dynamic_lookups: region.dynamic_lookup_index(),
-            dynamic_lookup_col_coord: region.dynamic_lookup_col_coord(),
             num_shuffles: region.shuffle_index(),
             shuffle_col_coord: region.shuffle_col_coord(),
             outputs,