Update docs.

[azteca1998]

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 ✅

Project coverage is 82.44%. Comparing base (ac0e5ca) to head (c5272da).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #961   +/-   ##
=======================================
  Coverage   82.44%   82.44%           
=======================================
  Files         117      117           
  Lines       34071    34073    +2     
=======================================
+ Hits        28091    28093    +2     
  Misses       5980     5980           

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

[github-actions]

Benchmark results Main vs HEAD.

Command	Mean [s]	Min [s]	Max [s]	Relative
base factorial_2M.cairo (JIT)	3.267 ± 0.017	3.228	3.288	1.00
base factorial_2M.cairo (AOT)	3.508 ± 0.061	3.414	3.598	1.07 ± 0.02
Command	Mean [s]	Min [s]	Max [s]	Relative
:---	---:	---:	---:	---:
head factorial_2M.cairo (JIT)	3.281 ± 0.032	3.244	3.343	1.00
head factorial_2M.cairo (AOT)	3.501 ± 0.033	3.456	3.549	1.07 ± 0.01

Command	Mean [s]	Min [s]	Max [s]	Relative
base fib_2M.cairo (JIT)	2.845 ± 0.034	2.802	2.911	1.00
base fib_2M.cairo (AOT)	3.021 ± 0.022	2.986	3.057	1.06 ± 0.01
Command	Mean [s]	Min [s]	Max [s]	Relative
:---	---:	---:	---:	---:
head fib_2M.cairo (JIT)	2.876 ± 0.046	2.814	2.957	1.00
head fib_2M.cairo (AOT)	3.098 ± 0.037	3.056	3.163	1.08 ± 0.02

Command	Mean [s]	Min [s]	Max [s]	Relative
base linear_search.cairo (JIT)	2.946 ± 0.019	2.919	2.970	1.00
base linear_search.cairo (AOT)	3.068 ± 0.031	3.025	3.133	1.04 ± 0.01
Command	Mean [s]	Min [s]	Max [s]	Relative
:---	---:	---:	---:	---:
head linear_search.cairo (JIT)	3.088 ± 0.072	2.988	3.240	1.00
head linear_search.cairo (AOT)	3.150 ± 0.032	3.099	3.202	1.02 ± 0.03

Command	Mean [s]	Min [s]	Max [s]	Relative
base logistic_map.cairo (JIT)	3.049 ± 0.019	3.025	3.083	1.00
base logistic_map.cairo (AOT)	3.133 ± 0.041	3.080	3.215	1.03 ± 0.02
Command	Mean [s]	Min [s]	Max [s]	Relative
:---	---:	---:	---:	---:
head logistic_map.cairo (JIT)	3.222 ± 0.076	3.073	3.349	1.00
head logistic_map.cairo (AOT)	3.241 ± 0.041	3.183	3.303	1.01 ± 0.03

[github-actions]

Benchmarking results

Benchmark for program factorial_2M

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	11.126 ± 0.373	10.628	11.649	8.26 ± 0.28
cairo-native (embedded AOT)	3.476 ± 0.043	3.390	3.526	2.58 ± 0.03
cairo-native (embedded JIT using LLVM's ORC Engine)	3.229 ± 0.021	3.185	3.264	2.40 ± 0.02
cairo-native (standalone AOT with -march=native)	1.347 ± 0.001	1.345	1.350	1.00

Benchmark for program fib_2M

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	10.940 ± 0.335	10.579	11.396	140.50 ± 4.33
cairo-native (embedded AOT)	3.097 ± 0.186	2.936	3.442	39.77 ± 2.39
cairo-native (embedded JIT using LLVM's ORC Engine)	2.746 ± 0.015	2.724	2.772	35.26 ± 0.23
cairo-native (standalone AOT with -march=native)	0.078 ± 0.000	0.077	0.079	1.00

Benchmark for program linear_search

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	4.665 ± 0.073	4.535	4.777	2354.32 ± 62.42
cairo-native (embedded AOT)	3.239 ± 0.039	3.163	3.304	1634.36 ± 40.19
cairo-native (embedded JIT using LLVM's ORC Engine)	3.030 ± 0.069	2.938	3.128	1529.02 ± 47.63
cairo-native (standalone AOT with -march=native)	0.002 ± 0.000	0.002	0.002	1.00

Benchmark for program logistic_map

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	4.440 ± 0.077	4.338	4.589	18.26 ± 0.32
cairo-native (embedded AOT)	3.326 ± 0.039	3.250	3.373	13.68 ± 0.16
cairo-native (embedded JIT using LLVM's ORC Engine)	3.433 ± 0.048	3.351	3.522	14.12 ± 0.20
cairo-native (standalone AOT with -march=native)	0.243 ± 0.000	0.243	0.244	1.00