Introduce memray on the profilers episode

Open Beginner friendly
#233 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Find the profilers episode and its current list of profilers in the course materials, then read the surrounding entries to match their format. Add memray with a short description of when it is useful, including the memory-trace caveat noted in the issue. Done when it appears in the current profiler list with that description.

Written by the indexing model from the issue text.

Description

From @matt-graham

That memray is a really nice tool for doing in-depth memory profiling of Python scripts. The temporal flamegraph outputis particularly useful for pinning down what is causing particular memory usage spikes, though beware trying it on very long profiling traces as it can produces extremely large (>1GB) HTML files.

Definition of Done:

Listed in the current list of profilers, with a small description of when it may be useful.

Dominant language
Python
Stars
133
Forks
111
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from UCL/rsd-engineeringcourse

All issues in UCL/rsd-engineeringcourse

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.