A simple IPython extension for monitoring memory usage of Jupyter notebook cells.
Project description
memprofiler
memprofiler is a simple extension for monitoring memory usage of Jupyter notebook cells.
Installation
It can be installed as a typical Python source package from PyPi using pip:
pip install memprofiler
Usage
A basic example of how to use this extension can be found in this interactive Jupyter notebook.
Reference
mprof_run
%%mprof_run [-i INTERVAL] [-p] profile_id
Run memory profiler during cell execution. (cell_magic)
-
positional arguments:
- profile_id
Profile identifier to label the results.
- profile_id
-
optional arguments:
-
-i INTERVAL, --interval INTERVAL
Sampling period (in seconds), default 0.01. -
-p, --plot
Plot the memory profile.
-
mprof_plot
%mprof_plot [-t TITLE] profile_ids [profile_ids ...]
Plot memory profiler results. (line_magic)
- positional arguments:
- profile_ids
Profile identifiers made by mprof_run. Supports regex.
- profile_ids
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the BSD 3-Clause License. See LICENSE for more information.
Acknowledgements
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.