dyson-ai / bencher

A package for benchmarking the characteristics of arbitrary functions
https://bencher.readthedocs.io/en/latest/
MIT License
2 stars 3 forks source link

Feature/demo #438

Closed blooop closed 1 month ago

blooop commented 1 month ago

Summary by Sourcery

Enhance the README with new sections for installation, demo, examples, and documentation to improve user guidance and accessibility.

Documentation:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request adds installation instructions, a demo section, examples, and documentation links to the README.md file. It enhances the project's documentation by providing more information on how to use and understand the Bencher tool.

File-Level Changes

Change Details Files
Added installation instructions
  • Included a pip install command for holobench
README.md
Added a demo section
  • Included instructions for running a demo using pixi
  • Mentioned the example output link
README.md
Added an examples section
  • Mentioned that most features are demonstrated in the examples folder
  • Suggested starting with example_simple_float.py
  • Advised looking for examples matching specific datatypes
README.md
Added a documentation section
  • Included a link to the API documentation
  • Noted that more documentation is needed for examples and general workflow
README.md

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 90.48%. Comparing base (5bed733) to head (e54c8d9). Report is 7 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #438 +/- ## ======================================= Coverage 90.48% 90.48% ======================================= Files 61 61 Lines 3384 3384 ======================================= Hits 3062 3062 Misses 322 322 ```

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