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

docs: document deserialization modules and update lib module's doc #1334

Merged
merged 11 commits into from
Jul 18, 2023

Conversation

MegaRedHand
Copy link
Contributor

@MegaRedHand MegaRedHand commented Jul 14, 2023

Description

This PR updates the lib module's documentation, and adds module level documentation for the Program deserialization related modules. It also makes the deserialization_utils module private and deletes an unused error struct.

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.

@github-actions
Copy link

github-actions bot commented Jul 14, 2023

Benchmark Results for unmodified programs 🚀

Command Mean [s] Min [s] Max [s] Relative
base big_factorial 3.748 ± 0.023 3.712 3.794 1.00 ± 0.01
head big_factorial 3.732 ± 0.020 3.712 3.770 1.00
Command Mean [s] Min [s] Max [s] Relative
base big_fibonacci 3.240 ± 0.017 3.216 3.265 1.01 ± 0.01
head big_fibonacci 3.213 ± 0.023 3.192 3.267 1.00
Command Mean [s] Min [s] Max [s] Relative
base blake2s_integration_benchmark 9.094 ± 0.053 9.044 9.211 1.00
head blake2s_integration_benchmark 9.184 ± 0.095 9.102 9.431 1.01 ± 0.01
Command Mean [s] Min [s] Max [s] Relative
base compare_arrays_200000 3.242 ± 0.025 3.210 3.298 1.02 ± 0.01
head compare_arrays_200000 3.190 ± 0.019 3.171 3.227 1.00
Command Mean [s] Min [s] Max [s] Relative
base dict_integration_benchmark 2.239 ± 0.009 2.228 2.254 1.01 ± 0.01
head dict_integration_benchmark 2.209 ± 0.019 2.198 2.260 1.00
Command Mean [s] Min [s] Max [s] Relative
base field_arithmetic_get_square_benchmark 1.703 ± 0.012 1.695 1.734 1.00
head field_arithmetic_get_square_benchmark 1.716 ± 0.010 1.704 1.732 1.01 ± 0.01
Command Mean [s] Min [s] Max [s] Relative
base integration_builtins 9.101 ± 0.022 9.058 9.139 1.00
head integration_builtins 9.186 ± 0.072 9.128 9.357 1.01 ± 0.01
Command Mean [s] Min [s] Max [s] Relative
base keccak_integration_benchmark 9.328 ± 0.167 9.175 9.729 1.01 ± 0.02
head keccak_integration_benchmark 9.193 ± 0.086 9.133 9.370 1.00
Command Mean [s] Min [s] Max [s] Relative
base linear_search 3.290 ± 0.018 3.263 3.320 1.00 ± 0.01
head linear_search 3.281 ± 0.035 3.257 3.373 1.00
Command Mean [s] Min [s] Max [s] Relative
base math_cmp_and_pow_integration_benchmark 2.365 ± 0.008 2.353 2.375 1.02 ± 0.01
head math_cmp_and_pow_integration_benchmark 2.320 ± 0.014 2.302 2.337 1.00
Command Mean [s] Min [s] Max [s] Relative
base math_integration_benchmark 2.169 ± 0.015 2.150 2.202 1.00 ± 0.01
head math_integration_benchmark 2.159 ± 0.015 2.146 2.197 1.00
Command Mean [s] Min [s] Max [s] Relative
base memory_integration_benchmark 1.868 ± 0.014 1.855 1.894 1.00
head memory_integration_benchmark 1.877 ± 0.010 1.858 1.889 1.00 ± 0.01
Command Mean [s] Min [s] Max [s] Relative
base operations_with_data_structures_benchmarks 2.165 ± 0.072 2.130 2.365 1.03 ± 0.04
head operations_with_data_structures_benchmarks 2.110 ± 0.021 2.088 2.157 1.00
Command Mean [ms] Min [ms] Max [ms] Relative
base pedersen 821.3 ± 2.0 817.9 824.8 1.00
head pedersen 821.5 ± 2.6 818.4 826.9 1.00 ± 0.00
Command Mean [s] Min [s] Max [s] Relative
base poseidon_integration_benchmark 1.497 ± 0.008 1.487 1.509 1.00 ± 0.01
head poseidon_integration_benchmark 1.492 ± 0.004 1.486 1.497 1.00
Command Mean [s] Min [s] Max [s] Relative
base secp_integration_benchmark 2.476 ± 0.021 2.460 2.535 1.00 ± 0.01
head secp_integration_benchmark 2.475 ± 0.017 2.456 2.510 1.00
Command Mean [s] Min [s] Max [s] Relative
base set_integration_benchmark 1.259 ± 0.010 1.251 1.280 1.02 ± 0.01
head set_integration_benchmark 1.239 ± 0.011 1.228 1.263 1.00
Command Mean [s] Min [s] Max [s] Relative
base uint256_integration_benchmark 6.033 ± 0.029 5.999 6.083 1.00
head uint256_integration_benchmark 6.044 ± 0.047 6.001 6.147 1.00 ± 0.01

@codecov
Copy link

codecov bot commented Jul 17, 2023

Codecov Report

Merging #1334 (04c3575) into main (7ee9be8) will increase coverage by 0.03%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1334      +/-   ##
==========================================
+ Coverage   97.47%   97.50%   +0.03%     
==========================================
  Files          92       92              
  Lines       37692    37679      -13     
==========================================
  Hits        36740    36740              
+ Misses        952      939      -13     
Impacted Files Coverage Δ
vm/src/serde/deserialize_program.rs 97.32% <ø> (ø)
vm/src/lib.rs 100.00% <100.00%> (ø)
vm/src/serde/deserialize_utils.rs 99.28% <100.00%> (+2.24%) ⬆️

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

@Oppen Oppen added this pull request to the merge queue Jul 18, 2023
Merged via the queue into main with commit e1bfb73 Jul 18, 2023
36 checks passed
@Oppen Oppen deleted the doc-some-modules branch July 18, 2023 16:14
kariy pushed a commit to dojoengine/cairo-rs that referenced this pull request Jul 25, 2023
…ambdaclass#1334)

* Document Program deserialization modules

* Update lib.rs module documentation

* Update changelog

* Make deserialize utils private

* Update fuzzer's Cargo.lock

* Make take_until_unbalanced private

* Update docs

* Fix links

* Update changelog entry

---------

Co-authored-by: Pedro Fontana <fontana.pedro93@gmail.com>
kariy pushed a commit to dojoengine/cairo-rs that referenced this pull request Jul 25, 2023
…ambdaclass#1334)

* Document Program deserialization modules

* Update lib.rs module documentation

* Update changelog

* Make deserialize utils private

* Update fuzzer's Cargo.lock

* Make take_until_unbalanced private

* Update docs

* Fix links

* Update changelog entry

---------

Co-authored-by: Pedro Fontana <fontana.pedro93@gmail.com>
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.

None yet

4 participants