Skip to content

Commit dfd8116

Browse files
committed
docs cleanup
1 parent c2e5dca commit dfd8116

File tree

1 file changed

+8
-24
lines changed

1 file changed

+8
-24
lines changed

README.md

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Extension of [zkml](https://github.com/uiuc-kang-lab/zkml) for distributed proving using Ray, layer-wise partitioning, and Merkle trees.
44

5-
> **⚠️ Status Note:** This is an experimental research project. For production zkML, consider [ZKTorch](https://github.com/uiuc-kang-lab/zktorch) (from the same research group) which uses proof accumulation/folding for parallelization. See [Status and Limitations](#status-and-limitations) for details.
5+
> **⚠️ Status Note:** This is an experimental research project. For production zkml, consider [zk-torch](https://github.com/uiuc-kang-lab/zk-torch) which uses proof folding for parallelization. See [Status and Limitations](#status-and-limitations) for details.
66
77
## Completed Milestones
88

@@ -11,8 +11,6 @@ Extension of [zkml](https://github.com/uiuc-kang-lab/zkml) for distributed provi
1111
3. ~~**Ray-Rust integration**: Connect Python Ray workers to Rust proof generation ([#9](https://github.com/ray-project/distributed-zkml/issues/9))~~ Done
1212
4. ~~**GPU acceleration**: ICICLE GPU backend for MSM operations ([#10](https://github.com/ray-project/distributed-zkml/issues/10))~~ Done - see [GPU Acceleration](#gpu-acceleration)
1313

14-
**Note**: This project is experimental. For production zkML, see [ZKTorch](https://github.com/uiuc-kang-lab/zktorch) or [Status and Limitations](#status-and-limitations).
15-
1614
---
1715

1816
## Table of Contents
@@ -32,36 +30,22 @@ Extension of [zkml](https://github.com/uiuc-kang-lab/zkml) for distributed provi
3230

3331
### Project Status
3432

35-
This project implements a **Ray-based distributed proving approach** for zkML. It is experimental research code and should be considered:
36-
37-
- **Research/Educational**: Useful for studying alternative approaches to zkML parallelization
38-
- **Not Production-Ready**: Missing formal security analysis and proof composition
39-
- **Superseded**: The same research group (UIUC Kang Lab) has released [ZKTorch](https://github.com/uiuc-kang-lab/zktorch), which uses proof accumulation/folding for parallelization
33+
This project implements a **Ray-based distributed proving approach** for zkml. It is experimental research code and should be considered useful for studying alternative approaches to zkML parallelization. The current status lacks formal security analysis and proof composition.
4034

4135
### Known Limitations
4236

43-
1. **Proof Composition**: This implementation generates separate proofs per chunk. It does not implement recursive proof composition or aggregation. Verifiers must check O(n) proofs rather than O(1), limiting succinctness.
37+
**Proof Composition**: This implementation generates separate proofs per chunk. It does not implement recursive proof composition or aggregation. Verifiers must check O(n) proofs rather than O(1), limiting succinctness.
4438

45-
2. **Security Assumptions**: The distributed trust model (Ray workers) is not formally analyzed. The README does not address:
46-
- Malicious worker resistance
47-
- Collusion resistance
48-
- Byzantine fault tolerance
49-
50-
3. **Scalability**: No published benchmarks comparing distributed vs. single-node performance. The approach inherits base zkml limitations (~30-80M parameter ceiling for halo2-based circuits).
39+
**Security Assumptions**: The distributed trust model (Ray workers) is not formally analyzed. It does not address malicious worker resistance, collusion resistance, and Byzantine fault tolerance.
5140

5241
### When to Use This
5342

5443
**Consider this project if:**
55-
- Researching alternative zkML parallelization approaches
44+
- Researching alternative zkml parallelization approaches
5645
- Need examples of Ray integration for cryptographic workloads
5746
- Studying Merkle-based privacy for intermediate computations
5847
- Building distributed halo2 proving (not zkML-specific)
5948

60-
**Use alternatives instead if:**
61-
- Need production-ready zkML → Use [ZKTorch](https://github.com/uiuc-kang-lab/zktorch) or [EZKL](https://github.com/zkonduit/ezkl)
62-
- Require formal security guarantees → Use frameworks with proven composition
63-
- Need state-of-the-art performance → ZKTorch achieves 10min GPT-2 proofs vs. ~1 hour for base zkml
64-
6549
---
6650

6751
## Overview
@@ -90,7 +74,7 @@ distributed-zkml adds:
9074
3. **Merkle Commitments**: Hash intermediate outputs with Poseidon, only root is public
9175
4. **On-Chain**: Publish only the Merkle root (O(1) public values vs O(n) without)
9276

93-
**Note**: Each chunk produces a separate proof. This implementation does not aggregate proofs into a single succinct proof. Verifiers must check all chunk proofs individually (O(n) verification time). For single-proof aggregation, see [ZKTorch](https://github.com/uiuc-kang-lab/zktorch)'s accumulation-based approach.
77+
**Note**: Each chunk produces a separate proof. This implementation does not aggregate proofs into a single succinct proof. Verifiers must check all chunk proofs individually (O(n) verification time). For single-proof aggregation, see [zk-orch](hhttps://github.com/uiuc-kang-lab/zk-torch)'s accumulation-based approach.
9478

9579
\`\`\`
9680
Model: 9 layers -> 3 chunks
@@ -202,7 +186,7 @@ Registered devices: ["CUDA", "CPU"]
202186
Successfully set CUDA device 0
203187
\`\`\`
204188

205-
### Benchmarks (Tesla T4)
189+
### Benchmarks (T4)
206190

207191
| Size | GPU MSM Time | Throughput |
208192
|------|--------------|------------|
@@ -249,4 +233,4 @@ Runs on PRs to \`main\`/\`dev\`: builds zkml, runs tests (~3-4 min). GPU tests e
249233

250234
- [ZKML Paper](https://ddkang.github.io/papers/2024/zkml-eurosys.pdf) (EuroSys '24) - Original zkml framework
251235
- [zkml Repository](https://github.com/uiuc-kang-lab/zkml) - Base framework this project extends
252-
- [ZKTorch](https://github.com/uiuc-kang-lab/zktorch) - Alternative approach using proof accumulation/folding (from same research group)
236+
- [zk-torch](https://github.com/uiuc-kang-lab/zk-torch) - Alternative approach using proof accumulation/folding (from same research group)

0 commit comments

Comments
 (0)