rust-ml / linfa

A Rust machine learning framework.
Apache License 2.0
3.7k stars 243 forks source link

add some benchmarking guidance #267

Closed oojo12 closed 1 year ago

oojo12 commented 1 year ago

This PR adds some documentation to the Contribute.MD. It aims to provide some guidance for writing benchmarks. At a later time, a benchmark will be referenced in the section to assist the community.

Resolves #265

codecov-commenter commented 1 year ago

Codecov Report

Base: 38.68% // Head: 38.75% // Increases project coverage by +0.06% :tada:

Coverage data is based on head (2a7927e) compared to base (fb17c62). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #267 +/- ## ========================================== + Coverage 38.68% 38.75% +0.06% ========================================== Files 93 93 Lines 6087 6087 ========================================== + Hits 2355 2359 +4 + Misses 3732 3728 -4 ``` | [Impacted Files](https://codecov.io/gh/rust-ml/linfa/pull/267?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) | Coverage Δ | | |---|---|---| | [...rithms/linfa-trees/src/decision\_trees/algorithm.rs](https://codecov.io/gh/rust-ml/linfa/pull/267/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None#diff-YWxnb3JpdGhtcy9saW5mYS10cmVlcy9zcmMvZGVjaXNpb25fdHJlZXMvYWxnb3JpdGhtLnJz) | `39.73% <0.00%> (+1.78%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.