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

Update docs, cairo-lang-runner references #1854

Merged
merged 5 commits into from
Oct 23, 2024
Merged

Update docs, cairo-lang-runner references #1854

merged 5 commits into from
Oct 23, 2024

Conversation

pefontana
Copy link
Member

Update docs

Specify that the implementation of certain Cairo 1 functions are inspired by the cairo-lang-runner crate.

Reference:

Checklist

  • Linked to Github Issue
  • Unit tests added
  • Integration tests added.
  • This change requires new documentation.
    • Documentation has been added/updated.
    • CHANGELOG has been updated.

@pefontana pefontana added the documentation Improvements or additions to documentation label Oct 16, 2024
@pefontana pefontana changed the title Update docs Update docs, cairo-lang-runner references Oct 16, 2024
Copy link

github-actions bot commented Oct 16, 2024

**Hyper Thereading Benchmark results**




hyperfine -r 2 -n "hyper_threading_main threads: 1" 'RAYON_NUM_THREADS=1 ./hyper_threading_main' -n "hyper_threading_pr threads: 1" 'RAYON_NUM_THREADS=1 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 1
  Time (mean ± σ):     33.241 s ±  0.085 s    [User: 32.405 s, System: 0.834 s]
  Range (min … max):   33.181 s … 33.301 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 1
  Time (mean ± σ):     33.163 s ±  0.064 s    [User: 32.419 s, System: 0.743 s]
  Range (min … max):   33.117 s … 33.208 s    2 runs
 
Summary
  'hyper_threading_pr threads: 1' ran
    1.00 ± 0.00 times faster than 'hyper_threading_main threads: 1'




hyperfine -r 2 -n "hyper_threading_main threads: 2" 'RAYON_NUM_THREADS=2 ./hyper_threading_main' -n "hyper_threading_pr threads: 2" 'RAYON_NUM_THREADS=2 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 2
  Time (mean ± σ):     17.802 s ±  0.077 s    [User: 31.144 s, System: 0.786 s]
  Range (min … max):   17.748 s … 17.857 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 2
  Time (mean ± σ):     17.876 s ±  0.181 s    [User: 31.284 s, System: 0.716 s]
  Range (min … max):   17.747 s … 18.004 s    2 runs
 
Summary
  'hyper_threading_main threads: 2' ran
    1.00 ± 0.01 times faster than 'hyper_threading_pr threads: 2'




hyperfine -r 2 -n "hyper_threading_main threads: 4" 'RAYON_NUM_THREADS=4 ./hyper_threading_main' -n "hyper_threading_pr threads: 4" 'RAYON_NUM_THREADS=4 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 4
  Time (mean ± σ):     12.479 s ±  0.563 s    [User: 44.188 s, System: 0.966 s]
  Range (min … max):   12.081 s … 12.877 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 4
  Time (mean ± σ):     12.391 s ±  0.039 s    [User: 43.603 s, System: 0.888 s]
  Range (min … max):   12.363 s … 12.419 s    2 runs
 
Summary
  'hyper_threading_pr threads: 4' ran
    1.01 ± 0.05 times faster than 'hyper_threading_main threads: 4'




hyperfine -r 2 -n "hyper_threading_main threads: 6" 'RAYON_NUM_THREADS=6 ./hyper_threading_main' -n "hyper_threading_pr threads: 6" 'RAYON_NUM_THREADS=6 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 6
  Time (mean ± σ):     12.102 s ±  0.104 s    [User: 44.083 s, System: 1.000 s]
  Range (min … max):   12.028 s … 12.175 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 6
  Time (mean ± σ):     12.165 s ±  0.368 s    [User: 44.420 s, System: 0.940 s]
  Range (min … max):   11.905 s … 12.426 s    2 runs
 
Summary
  'hyper_threading_main threads: 6' ran
    1.01 ± 0.03 times faster than 'hyper_threading_pr threads: 6'




hyperfine -r 2 -n "hyper_threading_main threads: 8" 'RAYON_NUM_THREADS=8 ./hyper_threading_main' -n "hyper_threading_pr threads: 8" 'RAYON_NUM_THREADS=8 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 8
  Time (mean ± σ):     12.027 s ±  0.331 s    [User: 44.482 s, System: 0.995 s]
  Range (min … max):   11.792 s … 12.261 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 8
  Time (mean ± σ):     12.019 s ±  0.107 s    [User: 44.298 s, System: 0.952 s]
  Range (min … max):   11.943 s … 12.094 s    2 runs
 
Summary
  'hyper_threading_pr threads: 8' ran
    1.00 ± 0.03 times faster than 'hyper_threading_main threads: 8'




hyperfine -r 2 -n "hyper_threading_main threads: 16" 'RAYON_NUM_THREADS=16 ./hyper_threading_main' -n "hyper_threading_pr threads: 16" 'RAYON_NUM_THREADS=16 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 16
  Time (mean ± σ):     11.924 s ±  0.156 s    [User: 44.732 s, System: 1.038 s]
  Range (min … max):   11.814 s … 12.034 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 16
  Time (mean ± σ):     12.013 s ±  0.253 s    [User: 44.733 s, System: 1.108 s]
  Range (min … max):   11.834 s … 12.191 s    2 runs
 
Summary
  'hyper_threading_main threads: 16' ran
    1.01 ± 0.02 times faster than 'hyper_threading_pr threads: 16'


Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.32%. Comparing base (d2257d6) to head (1d6f72d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1854   +/-   ##
=======================================
  Coverage   96.32%   96.32%           
=======================================
  Files         102      102           
  Lines       40315    40315           
=======================================
  Hits        38832    38832           
  Misses       1483     1483           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

github-actions bot commented Oct 16, 2024

Benchmark Results for unmodified programs 🚀

Command Mean [s] Min [s] Max [s] Relative
base big_factorial 2.487 ± 0.032 2.454 2.543 1.00
head big_factorial 2.535 ± 0.111 2.448 2.770 1.02 ± 0.05
Command Mean [s] Min [s] Max [s] Relative
base big_fibonacci 2.444 ± 0.052 2.396 2.572 1.00 ± 0.03
head big_fibonacci 2.435 ± 0.044 2.392 2.526 1.00
Command Mean [s] Min [s] Max [s] Relative
base blake2s_integration_benchmark 9.179 ± 0.112 8.990 9.348 1.00
head blake2s_integration_benchmark 9.197 ± 0.103 9.032 9.390 1.00 ± 0.02
Command Mean [s] Min [s] Max [s] Relative
base compare_arrays_200000 2.565 ± 0.027 2.513 2.611 1.00
head compare_arrays_200000 2.604 ± 0.080 2.524 2.789 1.02 ± 0.03
Command Mean [s] Min [s] Max [s] Relative
base dict_integration_benchmark 1.695 ± 0.031 1.666 1.776 1.01 ± 0.03
head dict_integration_benchmark 1.673 ± 0.029 1.647 1.751 1.00
Command Mean [s] Min [s] Max [s] Relative
base field_arithmetic_get_square_benchmark 1.438 ± 0.014 1.419 1.465 1.01 ± 0.01
head field_arithmetic_get_square_benchmark 1.427 ± 0.014 1.412 1.450 1.00
Command Mean [s] Min [s] Max [s] Relative
base integration_builtins 9.213 ± 0.104 9.086 9.378 1.00
head integration_builtins 9.433 ± 0.436 9.101 10.349 1.02 ± 0.05
Command Mean [s] Min [s] Max [s] Relative
base keccak_integration_benchmark 9.497 ± 0.106 9.339 9.607 1.00
head keccak_integration_benchmark 9.646 ± 0.406 9.418 10.775 1.02 ± 0.04
Command Mean [s] Min [s] Max [s] Relative
base linear_search 2.566 ± 0.055 2.512 2.663 1.00
head linear_search 2.576 ± 0.092 2.504 2.824 1.00 ± 0.04
Command Mean [s] Min [s] Max [s] Relative
base math_cmp_and_pow_integration_benchmark 1.743 ± 0.017 1.718 1.766 1.01 ± 0.01
head math_cmp_and_pow_integration_benchmark 1.731 ± 0.019 1.702 1.760 1.00
Command Mean [s] Min [s] Max [s] Relative
base math_integration_benchmark 1.704 ± 0.018 1.682 1.735 1.00
head math_integration_benchmark 1.706 ± 0.031 1.660 1.756 1.00 ± 0.02
Command Mean [s] Min [s] Max [s] Relative
base memory_integration_benchmark 1.431 ± 0.043 1.396 1.536 1.01 ± 0.03
head memory_integration_benchmark 1.415 ± 0.017 1.394 1.444 1.00
Command Mean [s] Min [s] Max [s] Relative
base operations_with_data_structures_benchmarks 1.814 ± 0.013 1.792 1.833 1.00 ± 0.02
head operations_with_data_structures_benchmarks 1.813 ± 0.031 1.778 1.877 1.00
Command Mean [ms] Min [ms] Max [ms] Relative
base pedersen 589.3 ± 1.9 586.5 592.3 1.00
head pedersen 594.2 ± 3.5 591.5 603.0 1.01 ± 0.01
Command Mean [ms] Min [ms] Max [ms] Relative
base poseidon_integration_benchmark 693.2 ± 3.2 688.3 699.2 1.00
head poseidon_integration_benchmark 696.2 ± 12.5 685.3 726.8 1.00 ± 0.02
Command Mean [s] Min [s] Max [s] Relative
base secp_integration_benchmark 2.084 ± 0.021 2.059 2.126 1.01 ± 0.02
head secp_integration_benchmark 2.062 ± 0.023 2.038 2.112 1.00
Command Mean [ms] Min [ms] Max [ms] Relative
base set_integration_benchmark 711.5 ± 13.1 701.2 742.9 1.02 ± 0.02
head set_integration_benchmark 700.7 ± 5.6 695.5 711.6 1.00
Command Mean [s] Min [s] Max [s] Relative
base uint256_integration_benchmark 5.105 ± 0.084 4.992 5.299 1.01 ± 0.02
head uint256_integration_benchmark 5.060 ± 0.061 4.969 5.145 1.00

@FrancoGiachetta
Copy link
Contributor

FrancoGiachetta commented Oct 16, 2024

I think the module also needs to be referenced. It's the dict_manager.rs

@pefontana
Copy link
Member Author

I think the module also needs to be referenced. It's the dict_manager.rs

Nice catch @FrancoGiachetta !
done 89178e8

@pefontana pefontana added this pull request to the merge queue Oct 23, 2024
Merged via the queue into main with commit 159f67d Oct 23, 2024
73 checks passed
@pefontana pefontana deleted the update-docs branch October 23, 2024 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants