bloomberg / memray

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

docs: Document temporal flame graphs #391

Closed godlygeek closed 1 year ago

godlygeek commented 1 year ago

For your reviewing convenience, here's previews of the rendered temporal flame graph docs and news.

pablogsal commented 1 year ago

This LGTM. The only suggestion that I have is maybe including some tutorial-style example when we show two peaks and how everything looks depending on what we select, but we can do that later

godlygeek commented 1 year ago

but we can do that later

That's what I'm thinking. We probably want a demo where there's some setup code that uses a bunch of temporary memory, and then some other code that uses whatever was produced by the setup code, and we could demo how you could see what's going on in the setup phase vs the run phase. But that requires us to come up with some new demo code...

If we can come up with something good, we could add it as one of the example applications, and include its temporal flame graph in the docs so that people can easily play around with it.

godlygeek commented 1 year ago

I've opened #392. Let's come back to it, unless you can immediately think of a good program for showing this off.