Project-MONAI / Project-MONAI/tutorials
Add tutorial on memory management
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 2.5k
- Forks
- 803
- Avg merge
- 6d 22h
- Merged PRs (30d)
- 3
Description
See Issue https://github.com/Project-MONAI/MONAI/issues/6626 relating to memory management and interaction with the garbage collector. One solution that we've tried before and had success with was to use the GarbageCollector handler to clean unused references at certain times. This isn't ideal and not particularly Pythonic but without changes to the garbage collector to consider GPU memory there may be little choice. Certain design decisions and good practices can reduce the issue so a tutorial on the problem and how to deal with OOM issues would be really helpful.
Contributor guide
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
Start by reading linked issue #6626 and reviewing the GarbageCollector handler approach described here. Create a tutorial covering the memory-management problem, design practices that reduce out-of-memory issues, and how the handler can help clean unused references. Done means the tutorial clearly explains the problem and practical ways to address it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100