Skip to content

Commit

Permalink
docs: groth16 requirements, grammar in profiling docs (#1871)
Browse files Browse the repository at this point in the history
  • Loading branch information
nhtyy authored Dec 17, 2024
1 parent 3a26009 commit 91c1fe5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion book/docs/verification/onchain/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ By default, the proofs generated by SP1 are not verifiable onchain, as they are

> WARNING: The Groth16 and PLONK provers are only guaranteed to work on official releases of SP1. To
> use Groth16 or PLONK proving & verification locally, ensure that you have Docker installed and have
> at least 128GB of RAM.
> at least 32GB of RAM. Note that you might need to increase the memory limit for
> [docker desktop](https://docs.docker.com/desktop/settings-and-maintenance/settings/#resources) if you're running on Mac.
### Example

Expand Down
4 changes: 2 additions & 2 deletions book/docs/writing-programs/cycle-tracking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ This will log the cycle count for `block name` and include it in the `ExecutionR

### Profiling a ZKVM program

Profiling a zkVM program produces a profile ([example link](https://share.firefox.dev/3Om1pzz)) which makes it easy to examine program performance and see exactly where exactly VM cycles are being spent without needing to modify the program at all.
Profiling a zkVM program produces a useful visualization ([example profile](https://share.firefox.dev/3Om1pzz)) which makes it easy to examine program performance and see exactly where VM cycles are being spent without needing to modify the program at all.

To profile a program, you simply need to:
To profile a program, you need to:
1. Enable the profiling feature for `sp1-sdk` in `script/Cargo.toml`
2. Set the env variable `TRACE_FILE=trace.json` and then call `ProverClient::execute()` in your script.

Expand Down

0 comments on commit 91c1fe5

Please sign in to comment.