Update docs.

[azteca1998]

trafficstars

Checklist

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

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Please upload report for BASE (main@b92123c). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #961   +/-   ##
=======================================
  Coverage        ?   80.19%           
=======================================
  Files           ?      112           
  Lines           ?    29981           
  Branches        ?        0           
=======================================
  Hits            ?    24042           
  Misses          ?     5939           
  Partials        ?        0           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions[bot]]

Benchmark results Main vs HEAD.

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base dict_insert.cairo (JIT)	5.101 ± 0.054	5.033	5.160	1.01 ± 0.01
base dict_insert.cairo (AOT)	5.040 ± 0.035	4.996	5.112	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head dict_insert.cairo (JIT)	5.076 ± 0.028	5.033	5.127	1.02 ± 0.01
head dict_insert.cairo (AOT)	4.986 ± 0.031	4.954	5.055	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base dict_snapshot.cairo (JIT)	4.991 ± 0.045	4.922	5.060	1.03 ± 0.01
base dict_snapshot.cairo (AOT)	4.841 ± 0.029	4.795	4.874	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head dict_snapshot.cairo (JIT)	5.013 ± 0.029	4.967	5.051	1.02 ± 0.01
head dict_snapshot.cairo (AOT)	4.909 ± 0.031	4.851	4.947	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base factorial_2M.cairo (JIT)	5.284 ± 0.033	5.233	5.330	1.01 ± 0.01
base factorial_2M.cairo (AOT)	5.253 ± 0.031	5.216	5.310	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head factorial_2M.cairo (JIT)	5.369 ± 0.037	5.299	5.402	1.01 ± 0.01
head factorial_2M.cairo (AOT)	5.316 ± 0.030	5.275	5.360	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base fib_2M.cairo (JIT)	4.838 ± 0.027	4.802	4.890	1.01 ± 0.01
base fib_2M.cairo (AOT)	4.798 ± 0.017	4.775	4.830	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head fib_2M.cairo (JIT)	4.900 ± 0.033	4.860	4.972	1.01 ± 0.01
head fib_2M.cairo (AOT)	4.854 ± 0.034	4.816	4.926	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base linear_search.cairo (JIT)	5.017 ± 0.019	4.982	5.047	1.03 ± 0.01
base linear_search.cairo (AOT)	4.885 ± 0.020	4.843	4.907	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head linear_search.cairo (JIT)	5.123 ± 0.052	5.061	5.207	1.03 ± 0.01
head linear_search.cairo (AOT)	4.986 ± 0.050	4.919	5.070	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base logistic_map.cairo (JIT)	5.100 ± 0.032	5.031	5.139	1.03 ± 0.01
base logistic_map.cairo (AOT)	4.936 ± 0.022	4.913	4.970	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head logistic_map.cairo (JIT)	5.197 ± 0.039	5.132	5.273	1.03 ± 0.01
head logistic_map.cairo (AOT)	5.030 ± 0.038	4.973	5.087	1.00

[github-actions[bot]]

Benchmarking results

Benchmark for program dict_insert

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	11.365 ± 0.076	11.260	11.497	2.31 ± 0.02
cairo-native (embedded AOT)	4.911 ± 0.025	4.869	4.950	1.00
cairo-native (embedded JIT using LLVM's ORC Engine)	5.011 ± 0.028	4.977	5.063	1.02 ± 0.01

Benchmark for program dict_snapshot

Open benchmarks

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
Cairo-vm (Rust, Cairo 1)	791.0 ± 3.0	784.9	794.9	1.00
cairo-native (embedded AOT)	4814.4 ± 27.7	4776.3	4854.4	6.09 ± 0.04
cairo-native (embedded JIT using LLVM's ORC Engine)	4907.9 ± 32.3	4863.3	4968.3	6.20 ± 0.05

Benchmark for program factorial_2M

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	5.242 ± 0.029	5.190	5.271	1.00 ± 0.01
cairo-native (embedded AOT)	5.224 ± 0.033	5.168	5.265	1.00
cairo-native (embedded JIT using LLVM's ORC Engine)	5.262 ± 0.031	5.223	5.308	1.01 ± 0.01

Benchmark for program fib_2M

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	5.076 ± 0.027	5.032	5.112	1.07 ± 0.01
cairo-native (embedded AOT)	4.760 ± 0.023	4.732	4.795	1.00
cairo-native (embedded JIT using LLVM's ORC Engine)	4.803 ± 0.033	4.762	4.859	1.01 ± 0.01

Benchmark for program linear_search

Open benchmarks

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
Cairo-vm (Rust, Cairo 1)	819.8 ± 4.9	810.4	825.3	1.00
cairo-native (embedded AOT)	4854.0 ± 28.7	4816.4	4902.4	5.92 ± 0.05
cairo-native (embedded JIT using LLVM's ORC Engine)	4997.3 ± 36.3	4948.5	5054.0	6.10 ± 0.06

Benchmark for program logistic_map

Open benchmarks

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
Cairo-vm (Rust, Cairo 1)	532.9 ± 3.5	528.0	540.2	1.00
cairo-native (embedded AOT)	4894.4 ± 21.3	4866.6	4945.8	9.18 ± 0.07
cairo-native (embedded JIT using LLVM's ORC Engine)	5060.4 ± 24.6	5036.4	5121.9	9.50 ± 0.08

[gabrielbosio]

Closing in favor of #1254