Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cli args description to readme #1386

Merged
merged 3 commits into from
Aug 17, 2023
Merged

Add cli args description to readme #1386

merged 3 commits into from
Aug 17, 2023

Conversation

fmoletta
Copy link
Member

Solves #1349

@fmoletta fmoletta marked this pull request as ready for review August 17, 2023 18:26
@codecov
Copy link

codecov bot commented Aug 17, 2023

Codecov Report

Merging #1386 (190ecdd) into main (4d36f96) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1386   +/-   ##
=======================================
  Coverage   97.49%   97.49%           
=======================================
  Files          93       93           
  Lines       37924    37924           
=======================================
  Hits        36973    36973           
  Misses        951      951           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@github-actions
Copy link

github-actions bot commented Aug 17, 2023

Benchmark Results for unmodified programs 🚀

Command Mean [s] Min [s] Max [s] Relative
base big_factorial 4.104 ± 0.011 4.096 4.128 1.00 ± 0.00
head big_factorial 4.092 ± 0.014 4.079 4.127 1.00
Command Mean [s] Min [s] Max [s] Relative
base big_fibonacci 3.484 ± 0.011 3.468 3.501 1.00
head big_fibonacci 3.490 ± 0.014 3.472 3.516 1.00 ± 0.01
Command Mean [s] Min [s] Max [s] Relative
base blake2s_integration_benchmark 9.599 ± 0.017 9.584 9.643 1.00
head blake2s_integration_benchmark 9.623 ± 0.024 9.584 9.666 1.00 ± 0.00
Command Mean [s] Min [s] Max [s] Relative
base compare_arrays_200000 3.542 ± 0.007 3.532 3.554 1.00
head compare_arrays_200000 3.552 ± 0.008 3.543 3.570 1.00 ± 0.00
Command Mean [s] Min [s] Max [s] Relative
base dict_integration_benchmark 2.351 ± 0.004 2.344 2.357 1.00
head dict_integration_benchmark 2.359 ± 0.003 2.352 2.363 1.00 ± 0.00
Command Mean [s] Min [s] Max [s] Relative
base field_arithmetic_get_square_benchmark 1.722 ± 0.004 1.718 1.730 1.00 ± 0.00
head field_arithmetic_get_square_benchmark 1.721 ± 0.005 1.711 1.729 1.00
Command Mean [s] Min [s] Max [s] Relative
base integration_builtins 9.541 ± 0.068 9.492 9.669 1.00
head integration_builtins 9.557 ± 0.093 9.494 9.752 1.00 ± 0.01
Command Mean [s] Min [s] Max [s] Relative
base keccak_integration_benchmark 9.788 ± 0.063 9.749 9.961 1.00
head keccak_integration_benchmark 9.888 ± 0.280 9.769 10.677 1.01 ± 0.03
Command Mean [s] Min [s] Max [s] Relative
base linear_search 3.551 ± 0.007 3.539 3.559 1.00 ± 0.00
head linear_search 3.542 ± 0.008 3.531 3.553 1.00
Command Mean [s] Min [s] Max [s] Relative
base math_cmp_and_pow_integration_benchmark 2.599 ± 0.004 2.593 2.606 1.00
head math_cmp_and_pow_integration_benchmark 2.600 ± 0.007 2.589 2.614 1.00 ± 0.00
Command Mean [s] Min [s] Max [s] Relative
base math_integration_benchmark 2.308 ± 0.004 2.303 2.315 1.00
head math_integration_benchmark 2.308 ± 0.006 2.301 2.322 1.00 ± 0.00
Command Mean [s] Min [s] Max [s] Relative
base memory_integration_benchmark 2.058 ± 0.020 2.047 2.115 1.00 ± 0.01
head memory_integration_benchmark 2.056 ± 0.010 2.045 2.076 1.00
Command Mean [s] Min [s] Max [s] Relative
base operations_with_data_structures_benchmarks 2.259 ± 0.026 2.243 2.333 1.00 ± 0.01
head operations_with_data_structures_benchmarks 2.251 ± 0.006 2.241 2.262 1.00
Command Mean [ms] Min [ms] Max [ms] Relative
base pedersen 837.2 ± 0.9 835.3 838.5 1.00
head pedersen 837.4 ± 1.3 835.8 839.9 1.00 ± 0.00
Command Mean [s] Min [s] Max [s] Relative
base poseidon_integration_benchmark 1.483 ± 0.004 1.476 1.490 1.00 ± 0.00
head poseidon_integration_benchmark 1.479 ± 0.004 1.474 1.486 1.00
Command Mean [s] Min [s] Max [s] Relative
base secp_integration_benchmark 2.861 ± 0.005 2.853 2.868 1.00
head secp_integration_benchmark 2.865 ± 0.006 2.860 2.878 1.00 ± 0.00
Command Mean [s] Min [s] Max [s] Relative
base set_integration_benchmark 1.416 ± 0.003 1.411 1.422 1.00
head set_integration_benchmark 1.418 ± 0.003 1.413 1.424 1.00 ± 0.00
Command Mean [s] Min [s] Max [s] Relative
base uint256_integration_benchmark 6.334 ± 0.024 6.311 6.389 1.00 ± 0.01
head uint256_integration_benchmark 6.333 ± 0.025 6.309 6.395 1.00

README.md Outdated
For example, to obtain the air public inputs from a fibonacci program run, we can run :

```bash
target/release/cairo-vm-cli cairo_programs/fibonacci.json --layout all_cairo --proof_mode --air_public_input fibonacci_public_input.json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here i will use a program that is compiled with proof-mode in the Makefile

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh right

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@pefontana pefontana added this pull request to the merge queue Aug 17, 2023
Merged via the queue into main with commit f81b1d2 Aug 17, 2023
38 checks passed
@pefontana pefontana deleted the cli-args-readme branch August 17, 2023 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants