Skip to content

Update README of hint processor section #2202

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update README of hint processor section #2202

wants to merge 4 commits into from

Conversation

DiegoCivi
Copy link
Contributor

Update README of hint processor section

Description

The README on the hint processor section was outdated

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.

@DiegoCivi DiegoCivi added the documentation Improvements or additions to documentation label Sep 18, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 18, 2025 •
edited
Loading 

**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 ± σ):     22.411 s ±  0.019 s    [User: 20.787 s, System: 1.620 s]
  Range (min … max):   22.397 s … 22.424 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 1
  Time (mean ± σ):     22.401 s ±  0.071 s    [User: 20.780 s, System: 1.618 s]
  Range (min … max):   22.351 s … 22.451 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 ± σ):     12.183 s ±  0.000 s    [User: 20.839 s, System: 1.637 s]
  Range (min … max):   12.183 s … 12.183 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 2
  Time (mean ± σ):     12.228 s ±  0.004 s    [User: 20.885 s, System: 1.674 s]
  Range (min … max):   12.224 s … 12.231 s    2 runs
 
Summary
  hyper_threading_main threads: 2 ran
    1.00 ± 0.00 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 ± σ):     10.850 s ±  0.093 s    [User: 39.792 s, System: 1.871 s]
  Range (min … max):   10.784 s … 10.915 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 4
  Time (mean ± σ):     11.160 s ±  0.331 s    [User: 39.169 s, System: 1.794 s]
  Range (min … max):   10.926 s … 11.394 s    2 runs
 
Summary
  hyper_threading_main threads: 4 ran
    1.03 ± 0.03 times faster than hyper_threading_pr 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 ± σ):     11.187 s ±  0.200 s    [User: 39.260 s, System: 1.872 s]
  Range (min … max):   11.046 s … 11.328 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 6
  Time (mean ± σ):     11.086 s ±  0.116 s    [User: 39.475 s, System: 1.868 s]
  Range (min … max):   11.004 s … 11.168 s    2 runs
 
Summary
  hyper_threading_pr threads: 6 ran
    1.01 ± 0.02 times faster than hyper_threading_main 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 ± σ):     10.879 s ±  0.025 s    [User: 40.425 s, System: 1.865 s]
  Range (min … max):   10.861 s … 10.896 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 8
  Time (mean ± σ):     10.960 s ±  0.027 s    [User: 40.500 s, System: 1.825 s]
  Range (min … max):   10.941 s … 10.979 s    2 runs
 
Summary
  hyper_threading_main threads: 8 ran
    1.01 ± 0.00 times faster than hyper_threading_pr 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.021 s ±  0.172 s    [User: 40.730 s, System: 1.889 s]
  Range (min … max):   10.900 s … 11.142 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 16
  Time (mean ± σ):     11.103 s ±  0.200 s    [User: 40.482 s, System: 1.894 s]
  Range (min … max):   10.961 s … 11.244 s    2 runs
 
Summary
  hyper_threading_main threads: 16 ran
    1.01 ± 0.02 times faster than hyper_threading_pr threads: 16

@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 18, 2025 •
edited
Loading

Benchmark Results for unmodified programs 🚀

Command Mean [s] Min [s] Max [s] Relative
base big_factorial 2.114 ± 0.026 2.083 2.176 1.00
head big_factorial 2.118 ± 0.035 2.079 2.185 1.00 ± 0.02
Command Mean [s] Min [s] Max [s] Relative
base big_fibonacci 2.034 ± 0.020 2.007 2.063 1.00
head big_fibonacci 2.036 ± 0.031 2.008 2.107 1.00 ± 0.02
Command Mean [s] Min [s] Max [s] Relative
base blake2s_integration_benchmark 7.236 ± 0.100 7.095 7.331 1.00
head blake2s_integration_benchmark 7.297 ± 0.207 7.070 7.682 1.01 ± 0.03
Command Mean [s] Min [s] Max [s] Relative
base compare_arrays_200000 2.165 ± 0.015 2.148 2.182 1.00 ± 0.01
head compare_arrays_200000 2.158 ± 0.019 2.135 2.194 1.00
Command Mean [s] Min [s] Max [s] Relative
base dict_integration_benchmark 1.421 ± 0.010 1.408 1.435 1.00
head dict_integration_benchmark 1.429 ± 0.017 1.406 1.466 1.01 ± 0.01
Command Mean [s] Min [s] Max [s] Relative
base field_arithmetic_get_square_benchmark 1.202 ± 0.016 1.186 1.242 1.00 ± 0.02
head field_arithmetic_get_square_benchmark 1.197 ± 0.009 1.187 1.214 1.00
Command Mean [s] Min [s] Max [s] Relative
base integration_builtins 7.323 ± 0.083 7.207 7.426 1.00 ± 0.02
head integration_builtins 7.310 ± 0.101 7.175 7.439 1.00
Command Mean [s] Min [s] Max [s] Relative
base keccak_integration_benchmark 7.421 ± 0.066 7.256 7.500 1.00 ± 0.02
head keccak_integration_benchmark 7.397 ± 0.102 7.251 7.502 1.00
Command Mean [s] Min [s] Max [s] Relative
base linear_search 2.139 ± 0.023 2.111 2.196 1.00 ± 0.01
head linear_search 2.138 ± 0.014 2.117 2.162 1.00
Command Mean [s] Min [s] Max [s] Relative
base math_cmp_and_pow_integration_benchmark 1.497 ± 0.014 1.479 1.520 1.00
head math_cmp_and_pow_integration_benchmark 1.498 ± 0.018 1.481 1.539 1.00 ± 0.02
Command Mean [s] Min [s] Max [s] Relative
base math_integration_benchmark 1.459 ± 0.024 1.433 1.511 1.01 ± 0.02
head math_integration_benchmark 1.450 ± 0.019 1.427 1.496 1.00
Command Mean [s] Min [s] Max [s] Relative
base memory_integration_benchmark 1.213 ± 0.017 1.193 1.256 1.00 ± 0.02
head memory_integration_benchmark 1.210 ± 0.010 1.195 1.225 1.00
Command Mean [s] Min [s] Max [s] Relative
base operations_with_data_structures_benchmarks 1.525 ± 0.006 1.517 1.539 1.00 ± 0.01
head operations_with_data_structures_benchmarks 1.522 ± 0.005 1.514 1.529 1.00
Command Mean [ms] Min [ms] Max [ms] Relative
base pedersen 526.7 ± 2.1 523.4 530.9 1.00 ± 0.00
head pedersen 526.1 ± 1.6 523.7 528.0 1.00
Command Mean [ms] Min [ms] Max [ms] Relative
base poseidon_integration_benchmark 611.6 ± 3.8 605.8 619.7 1.00 ± 0.01
head poseidon_integration_benchmark 610.5 ± 4.3 605.6 620.5 1.00
Command Mean [s] Min [s] Max [s] Relative
base secp_integration_benchmark 1.776 ± 0.017 1.758 1.811 1.00 ± 0.01
head secp_integration_benchmark 1.772 ± 0.019 1.756 1.821 1.00
Command Mean [ms] Min [ms] Max [ms] Relative
base set_integration_benchmark 644.9 ± 3.3 640.0 649.9 1.00 ± 0.01
head set_integration_benchmark 644.3 ± 2.4 639.8 647.8 1.00
Command Mean [s] Min [s] Max [s] Relative
base uint256_integration_benchmark 4.122 ± 0.040 4.072 4.206 1.00
head uint256_integration_benchmark 4.138 ± 0.054 4.071 4.273 1.00 ± 0.02

@codecov Codecov
Copy link

codecov bot commented Sep 18, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.68%. Comparing base (958ae7e) to head (5b36acc).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #2202   +/-   ##
=======================================
  Coverage   96.68%   96.68%           
=======================================
  Files         104      104           
  Lines       44027    44027           
=======================================
  Hits        42566    42566           
  Misses       1461     1461

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@DiegoCivi DiegoCivi marked this pull request as ready for review September 19, 2025 19:59
gabrielbosio
gabrielbosio requested changes Sep 23, 2025
View reviewed changes
docs/hint_processor/builtin_hint_processor/README.md Outdated
* get_range_check_builtin
* bigint_to_usize
* bigint_to_u32
* get_offset_value
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think this function should added here because it's private

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True! Removed in 792d4f0

JulianGCalderon
JulianGCalderon reviewed Sep 26, 2025
View reviewed changes
Copy link
Contributor

@JulianGCalderon JulianGCalderon left a comment

Choose a reason for hiding this comment

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

Looks good! Left a small comment

JulianGCalderon
JulianGCalderon approved these changes Sep 29, 2025
View reviewed changes
Copy link
Contributor

@JulianGCalderon JulianGCalderon left a comment

Choose a reason for hiding this comment

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

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gabrielbosio gabrielbosio gabrielbosio requested changes

@JulianGCalderon JulianGCalderon JulianGCalderon approved these changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@DiegoCivi @gabrielbosio @JulianGCalderon