UCL / UCL/rsd-engineeringcourse
Introduce memray on the profilers episode
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 133
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100