search

bloomberg / memray

Memray is a memory profiler for Python
https://bloomberg.github.io/memray/
Apache License 2.0
13.17k stars 392 forks source link

Intro level tutorial for Memray #586

Closed jcarnaxide closed 4 months ago

jcarnaxide commented 4 months ago

Issue number of the reported bug or feature request: #

Describe your changes We have worked on an introductory level course for people to get familiar with Memray.

Testing performed We ran make docs-live to view the new RST files, and to see everything is rendered properly. We also ran the exercises via instructions specified and was able to get through the whole tutorial.

Additional context It is worth noting, that I plan to update the instructions to include running the tutorial via codespaces, but we stuck with simple venv/pip for this first PR.

codecov-commenter commented 4 months ago

Codecov Report

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

Project coverage is 92.88%. Comparing base (41248ed) to head (a07b536). Report is 33 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #586 +/- ## ========================================== + Coverage 92.55% 92.88% +0.32% ========================================== Files 91 91 Lines 11304 11195 -109 Branches 1581 2047 +466 ========================================== - Hits 10462 10398 -64 + Misses 837 797 -40 + Partials 5 0 -5 ``` | [Flag](https://app.codecov.io/gh/bloomberg/memray/pull/586/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | Coverage Δ | | |---|---|---| | [cpp](https://app.codecov.io/gh/bloomberg/memray/pull/586/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `92.88% <ø> (+6.94%)` | :arrow_up: | | [python_and_cython](https://app.codecov.io/gh/bloomberg/memray/pull/586/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `92.88% <ø> (-2.84%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg#carryforward-flags-in-the-pull-request-comment) to find out more.

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

jcarnaxide commented 4 months ago

Closing PR for new branch with proper commit signatures.