Skip to content

Commit cc477da

Browse files
docs: update readme with benchmark related changes (#274)
* docs: make the benchmark results hidden under an expandable section * docs: update readme's description of multi_commitment benchmarks * docs: improve the benchmark running text
1 parent 8fa0261 commit cc477da

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ Benchmarks are run against four different types of GPU:
142142
* [Nvidia A100 - Standard_NC24ads_A100_v4](https://learn.microsoft.com/en-us/azure/virtual-machines/nc-a100-v4-series)
143143
* [Nvidia A100 x4 - Standard_NC96ads_A100_v4](https://learn.microsoft.com/en-us/azure/virtual-machines/nc-a100-v4-series)
144144

145-
<details open>
146-
<summary>Multi-Scalar Multiplication / Generalized Pedersen Commitment Results:</summary>
145+
<details>
146+
<summary>Expand to see the multi-scalar multiplication / generalized Pedersen commitment results</summary>
147147

148148
The subsequent outcomes are derived from the preceding benchmark execution of the Pedersen commitment, during which the number of sequences, bytes per element, sequence length, and GPU type were varied.
149149

@@ -284,13 +284,14 @@ nix develop
284284
```bash
285285
nix develop
286286

287-
# Usage: benchmark <cpu|gpu> <n> <num_samples> <num_commitments> <element_nbytes> <verbose>
287+
# Usage: benchmark <cpu|gpu> <curve> <n> <num_samples> <num_commitments> <element_nbytes> <verbose>
288+
# - curve: the desired curve: curve25519, bn254, bls12_381, grumpkin
288289
# - n: the size of the multiexponentiation vector (or the sequence length).
289290
# - num_samples: the number of times to run the benchmark.
290291
# - num_commitments: the number of commitments to generate.
291292
# - element_nbytes: the number of bytes of each element in the vector (exponent size).
292293
# - verbose: whether to print the results of each run.
293-
bazel run -c opt //benchmark/multi_commitment:benchmark -- gpu 1000 5 1 32 1
294+
bazel run -c opt //benchmark/multi_commitment:benchmark -- gpu bn254 1000 5 1 32 1
294295
```
295296

296297
</details>

0 commit comments

Comments
 (0)