ezkl-lib-test7 v0.1.0
Easy Zero-Knowledge Inference
ezkl is a library and command-line tool for doing inference for deep learning models and other computational graphs in a zk-snark (ZKML). It enables the following workflow:
- Define a computational graph, for instance a neural network (but really any arbitrary set of operations), as you would normally in pytorch or tensorflow.
- Export the final graph of operations as an .onnx file and some sample inputs to a
.jsonfile. - Point
ezklto the.onnxand.jsonfiles to generate a ZK-SNARK circuit with which you can prove statements such as:"I ran this publicly available neural network on some private data and it produced this output"
"I ran my private neural network on some public data and it produced this output"
"I correctly ran this publicly available neural network on some public data and it produced this output"
In the backend we use Halo2 as a proof system.
resources 📖
| docs | the official ezkl docs page |
| tutorial | end-to-end tutorial using pytorch and ezkl |
| notebook | end-to-end tutorial using pytorch and ezkl in a jupyter notebook |
cargo doc --open | compile and open the docs in your default browser |
Getting Started ⚙️
building the project 🔨
Note that the library requires a nightly version of the rust toolchain. You can change the default toolchain by running:
rustup override set nightlyAfter which you may build the library
cargo build --releaseA folder ./target/release will be generated. Add this folder to your PATH environment variable to call ezkl from the CLI.
# For UNIX like systems
# in .bashrc, .bash_profile, or some other path file
export PATH="<replace with where you cloned the repo>/ezkl/target/release:$PATH"Restart your shell or reload your shell settings
# example, replace .bash_profile with the file you use to configure your shell
source ~/.bash_profileYou will need a functioning installation of solc in order to run ezkl properly.
solc-select is recommended.
Follow the instructions on solc-select to activate solc in your environment.
Repos
The EZKL project has several libraries and repos.
| Repo | Description |
|---|---|
| @zkonduit/ezkl | the main ezkl repo in rust |
| @zkonduit/pyezkl | helper functions in python for processing onnx files |
| @zkonduit/ezkl-docs | official ezkl docs |
Contributing 🌎
If you're interested in contributing and are unsure where to start, reach out to one of the maintainers:
- dante (alexander-camuto)
- jason (jasonmorton)
More broadly:
Feel free to open up a discussion topic in Discussions to ask questions. Alternatively, you may join the EZKL Community Telegram Group to ask questions.
See currently open issues for ideas on how to contribute.
For PRs we use the conventional commits naming convention.
To report bugs or request new features create a new issue within Issues to inform the greater community.
12 months ago