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

Add a "memory overview" section to the docs #496

Closed pablogsal closed 10 months ago

pablogsal commented 10 months ago

Many users find resident vs heap memory confusing and they struggle to analyze properly programs where understanding the difference between the two is important. Furthermore, is very common that internal allocator-specific behaviours confuse users when they need to understand what is causing the resident size to increase or decrease.

To help users understand these problems and concepts, add a new memory overview section to the docs that covers most typical concepts and problems when analyzing memory.

codecov-commenter commented 10 months ago

Codecov Report

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

Comparison is base (26f04e2) 92.29% compared to head (7978316) 92.23%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #496 +/- ## ========================================== - Coverage 92.29% 92.23% -0.07% ========================================== Files 91 91 Lines 11033 11033 Branches 1524 1524 ========================================== - Hits 10183 10176 -7 - Misses 845 852 +7 Partials 5 5 ``` | [Flag](https://app.codecov.io/gh/bloomberg/memray/pull/496/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/496/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `85.69% <ø> (-0.20%)` | :arrow_down: | | [python_and_cython](https://app.codecov.io/gh/bloomberg/memray/pull/496/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `95.48% <ø> (ø)` | | 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. [see 2 files with indirect coverage changes](https://app.codecov.io/gh/bloomberg/memray/pull/496/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg)

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