update readme

gizatechxyz · Jun 24, 2024 · e199182 · e199182
1 parent 0cc5102
commit e199182
Show file tree

Hide file tree

Showing 27 changed files with 21 additions and 6 deletions.
diff --git a/packages/orion-graph/README.md b/packages/orion-graph/README.md
@@ -1,8 +1,8 @@
-# Orion2 - A scalable and modular ZKML framework
+# Orion-Graph - A ZKML framework for graph-based models
 
-Orion2 is a ZKML frameworks that uses composable ZK compilers to achieve modularity and scalability.
+Orion-Graph is a ZKML frameworks that uses composable ZK compilers to achieve modularity and scalability.
 
-With Orion2 you only need to add 11 primitive operations (primops) to support a new ZK backend:
+With Orion-Graph you only need to add 11 primitive operations (primops) to support a new ZK backend:
 - **Unary** - Log2, Exp2, Sin, Sqrt, Recip
 - **Binary** - Add, Mul, Mod, LessThan
 - **Other** - SumReduce, MaxReduce, Contiguous
@@ -13,4 +13,4 @@ Once the graph is built, iterative ZK compiler passes can modify it to replace p
 
 This approach leads to a simple library, and performance is only limited by the creativity of the compiler programmer, not the model programmer.
 
-![Orion2](https://github.com/gizatechxyz/orion2/assets/113879115/75320a2f-336f-49c8-a40e-7538aee50f9d)
+![Orion Diagram](packages/orion-graph/imgs/Orion-Graph-Diagram.png)
diff --git a/packages/orion-graph/imgs/Orion-Graph-Diagram.png b/packages/orion-graph/imgs/Orion-Graph-Diagram.png
diff --git a/packages/orion-graph/tests/test_cairo.py b/packages/orion-graph/tests/test_cairo.py
@@ -3,11 +3,11 @@
 
 def test_cairo():
     """
-    Test function for the zk-backend cairo.
+    Test function for the zk-backends cairo.
     """
     zk_backend = 'cairo'
 
-    result = subprocess.run(['scarb', 'test'], cwd=f"zk-backend/{zk_backend}", capture_output=True, text=True)
+    result = subprocess.run(['scarb', 'test'], cwd=f"zk-backends/{zk_backend}", capture_output=True, text=True)
 
     print(result.stdout)
     print(result.stderr)

diff --git a/...s/orion-graph/zk-backend/cairo/.gitignore → .../orion-graph/zk-backends/cairo/.gitignore b/...s/orion-graph/zk-backend/cairo/.gitignore → .../orion-graph/zk-backends/cairo/.gitignore
diff --git a/...ion-graph/zk-backend/cairo/.tool-versions → ...on-graph/zk-backends/cairo/.tool-versions b/...ion-graph/zk-backend/cairo/.tool-versions → ...on-graph/zk-backends/cairo/.tool-versions
diff --git a/...s/orion-graph/zk-backend/cairo/Scarb.toml → .../orion-graph/zk-backends/cairo/Scarb.toml b/...s/orion-graph/zk-backend/cairo/Scarb.toml → .../orion-graph/zk-backends/cairo/Scarb.toml
diff --git a/...-graph/zk-backend/cairo/src/helpers.cairo → ...graph/zk-backends/cairo/src/helpers.cairo b/...-graph/zk-backend/cairo/src/helpers.cairo → ...graph/zk-backends/cairo/src/helpers.cairo
diff --git a/...rion-graph/zk-backend/cairo/src/lib.cairo → ...ion-graph/zk-backends/cairo/src/lib.cairo b/...rion-graph/zk-backend/cairo/src/lib.cairo → ...ion-graph/zk-backends/cairo/src/lib.cairo
diff --git a/...-graph/zk-backend/cairo/src/numbers.cairo → ...graph/zk-backends/cairo/src/numbers.cairo b/...-graph/zk-backend/cairo/src/numbers.cairo → ...graph/zk-backends/cairo/src/numbers.cairo
diff --git a/...ph/zk-backend/cairo/src/numbers/erf.cairo → ...h/zk-backends/cairo/src/numbers/erf.cairo b/...ph/zk-backend/cairo/src/numbers/erf.cairo → ...h/zk-backends/cairo/src/numbers/erf.cairo
diff --git a/...zk-backend/cairo/src/numbers/f16x16.cairo → ...k-backends/cairo/src/numbers/f16x16.cairo b/...zk-backend/cairo/src/numbers/f16x16.cairo → ...k-backends/cairo/src/numbers/f16x16.cairo
diff --git a/...k-backend/cairo/src/numbers/helpers.cairo → ...-backends/cairo/src/numbers/helpers.cairo b/...k-backend/cairo/src/numbers/helpers.cairo → ...-backends/cairo/src/numbers/helpers.cairo
diff --git a/...ph/zk-backend/cairo/src/numbers/lut.cairo → ...h/zk-backends/cairo/src/numbers/lut.cairo b/...ph/zk-backend/cairo/src/numbers/lut.cairo → ...h/zk-backends/cairo/src/numbers/lut.cairo
diff --git a/...h/zk-backend/cairo/src/numbers/math.cairo → .../zk-backends/cairo/src/numbers/math.cairo b/...h/zk-backend/cairo/src/numbers/math.cairo → .../zk-backends/cairo/src/numbers/math.cairo
diff --git a/...h/zk-backend/cairo/src/numbers/trig.cairo → .../zk-backends/cairo/src/numbers/trig.cairo b/...h/zk-backend/cairo/src/numbers/trig.cairo → .../zk-backends/cairo/src/numbers/trig.cairo
diff --git a/...-graph/zk-backend/cairo/src/primops.cairo → ...graph/zk-backends/cairo/src/primops.cairo b/...-graph/zk-backend/cairo/src/primops.cairo → ...graph/zk-backends/cairo/src/primops.cairo
diff --git a/...-graph/zk-backend/cairo/src/tensors.cairo → ...graph/zk-backends/cairo/src/tensors.cairo b/...-graph/zk-backend/cairo/src/tensors.cairo → ...graph/zk-backends/cairo/src/tensors.cairo
diff --git a/...on-graph/zk-backend/cairo/tests/lib.cairo → ...n-graph/zk-backends/cairo/tests/lib.cairo b/...on-graph/zk-backend/cairo/tests/lib.cairo → ...n-graph/zk-backends/cairo/tests/lib.cairo
diff --git a/...aph/zk-backend/cairo/tests/test_mul.cairo → ...ph/zk-backends/cairo/tests/test_mul.cairo b/...aph/zk-backend/cairo/tests/test_mul.cairo → ...ph/zk-backends/cairo/tests/test_mul.cairo
diff --git a/...kend/cairo/tests/test_mul_broadcast.cairo → ...ends/cairo/tests/test_mul_broadcast.cairo b/...kend/cairo/tests/test_mul_broadcast.cairo → ...ends/cairo/tests/test_mul_broadcast.cairo
diff --git a/...st_reduce_sum_default_axes_keepdims.cairo → ...st_reduce_sum_default_axes_keepdims.cairo b/...st_reduce_sum_default_axes_keepdims.cairo → ...st_reduce_sum_default_axes_keepdims.cairo
diff --git a/...st_reduce_sum_empty_axes_input_noop.cairo → ...st_reduce_sum_empty_axes_input_noop.cairo b/...st_reduce_sum_empty_axes_input_noop.cairo → ...st_reduce_sum_empty_axes_input_noop.cairo
diff --git a/...iro/tests/test_reduce_sum_keep_dims.cairo → ...iro/tests/test_reduce_sum_keep_dims.cairo b/...iro/tests/test_reduce_sum_keep_dims.cairo → ...iro/tests/test_reduce_sum_keep_dims.cairo
diff --git a/...t_reduce_sum_negative_axes_keepdims.cairo → ...t_reduce_sum_negative_axes_keepdims.cairo b/...t_reduce_sum_negative_axes_keepdims.cairo → ...t_reduce_sum_negative_axes_keepdims.cairo
diff --git a/.../tests/test_reduce_sum_no_keep_dims.cairo → .../tests/test_reduce_sum_no_keep_dims.cairo b/.../tests/test_reduce_sum_no_keep_dims.cairo → .../tests/test_reduce_sum_no_keep_dims.cairo
diff --git a/...-graph/zk-backend/cairo/tests/utils.cairo → ...graph/zk-backends/cairo/tests/utils.cairo b/...-graph/zk-backend/cairo/tests/utils.cairo → ...graph/zk-backends/cairo/tests/utils.cairo
diff --git a/packages/orion-numbers/README.md b/packages/orion-numbers/README.md
@@ -0,0 +1,15 @@
+# Orion-Numbers: A Cairo Numbers Library
+
+## Fixed Points
+A fixed point library, inspired by [Cubit lib](https://github.com/influenceth/cubit).
+
+### Supported Implementations
+
+| Implementations | Status |
+| :-------------: | :----: |
+|      16x16      |   ✅    |
+|      32x32      |   ⏳    |
+|      64x64      |   ⏳    |
+
+
+A signed 16.16-bit fixed point number is a fraction in which the numerator is a signed 32-bit integer and the denominator is 2^16. Since the denominator stays the same there is no need to store it (as in a floating point value).