pythonprofilers / memory_profiler

Monitor Memory usage of Python code
http://pypi.python.org/pypi/memory_profiler
Other
4.39k stars 380 forks source link

Usage doesn't explain what the red lines mean #308

Open brando90 opened 3 years ago

brando90 commented 3 years ago

The extremely helpful usage page is missing an explanation of what the dotted red lines mean with mprof (https://pypi.org/project/memory-profiler/)

Can that be added there?

What does it mean?

example:

Screen Shot 2021-03-31 at 11 12 01 AM
brando90 commented 3 years ago

https://stackoverflow.com/questions/46005922/what-is-the-meaning-of-dashed-red-line-in-memory-profiler-plot

brando90 commented 3 years ago

It points to the peak in memory usage, both in terms of amount of memory (y axis) and time (x axis). This is perhaps best seen in this image