History

therealyingtong 72ce521084 circuit.rs: crate visibility modifications from code review Co-authored-by: Daira Hopwood <daira@jacaranda.org> Co-authored-by: ebfull <ewillbefull@gmail.com>		2023-04-04 09:32:08 +07:00
..
benches	Restrict query_fixed to current Rotation.	2022-12-09 16:47:19 +08:00
examples	Restrict query_fixed to current Rotation.	2022-12-09 16:47:19 +08:00
proptest-regressions/plonk	Move `halo2` code into `halo2_proofs` crate	2022-01-20 18:50:43 +00:00
src	circuit.rs: crate visibility modifications from code review	2023-04-04 09:32:08 +07:00
tests	Restrict query_fixed to current Rotation.	2022-12-09 16:47:19 +08:00
CHANGELOG.md	Release 0.3.0 of halo2_proofs and halo2_gadgets	2023-03-21 19:35:30 -06:00
Cargo.toml	Release 0.3.0 of halo2_proofs and halo2_gadgets	2023-03-21 19:35:30 -06:00
README.md	Fix formatting of `halo2_proofs::multicore` comments	2023-02-14 18:53:36 +00:00
katex-header.html	Fix docs.rs build	2022-03-17 19:14:11 +00:00

README.md

halo2_proofs

Documentation

Minimum Supported Rust Version

Requires Rust 1.60 or higher.

Minimum supported Rust version can be changed in the future, but it will be done with a minor version bump.

Controlling parallelism

halo2_proofs currently uses rayon for parallel computation. The RAYON_NUM_THREADS environment variable can be used to set the number of threads.

You can disable rayon by disabling the "multicore" feature. Warning! Halo2 will lose access to parallelism if you disable the "multicore" feature. This will significantly degrade performance.

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.