Simple Jupyter extension to show how much resources (RAM) your notebook is using
Project description
Installation | Configuration | Resources Displayed | Contributing
NBResuse
NB Resource Usage (NBResuse) is a small extension for Jupyter Notebooks that displays an indication of how much resources your current notebook server and its children (kernels, terminals, etc) are using. This is displayed in the main toolbar in the notebook itself, refreshing every 5s.
Installation
You can currently install this package from PyPI.
pip install nbresuse
If your notebook version is < 5.3, you need to enable the extension manually.
jupyter serverextension enable --py nbresuse --sys-prefix
jupyter nbextension install --py nbresuse --sys-prefix
jupyter nbextension enable --py nbresuse --sys-prefix
Configuration
Memory Limit
nbresuse
can display a memory limit (but not enforce it). You can set this
in several ways:
MEM_LIMIT
environment variable. This is set by JupyterHub if using a spawner that supports it.- In the commandline when starting
jupyter notebook
, as--ResourceUseDisplay.mem_limit
. - In your Jupyter notebook traitlets config file
The limit needs to be set as an integer in Bytes.
Memory usage warning threshold
The background of the resource display can be changed to red when the user is near a memory limit. The threshold for this warning can be configured as a fraction of the memory limit.
If you want to flash the warning to the user when they are within 10% of the memory limit, you
can set the parameter --ResourceUseDisplay.mem_warning_threshold=0.1
.
CPU Usage
nbresuse
can also track CPU usage and report a cpu_percent
value as part of the /metrics
response.
You can set the cpu_limit
in several ways:
CPU_LIMIT
environment variable. This is set by JupyterHub if using a spawner that supports it.- In the command line when starting
jupyter notebook
, as--ResourceUseDisplay.cpu_limit
. - In your Jupyter notebook traitlets config file
The limit corresponds to the number of cpus the user has access to, but does not enforce it.
Additionally, you can set the track_cpu_percent
trait to enable CPU usage tracking (disabled by default):
c = get_config()
c.NotebookApp.ResourceUseDisplay.track_cpu_percent = True
As a command line argument:
jupyter notebook --ResourceUseDisplay.track_cpu_percent=True
Resources Displayed
Currently the server extension only reports memory usage (just RSS) and CPU usage. Other metrics will be added in the future as needed.
The notebook extension currently doesn't show CPU usage, only memory usage.
Contributing
If you would like to contribute to the project, please read the CONTRIBUTING.md
. The CONTRIBUTING.md
file
explains how to set up a development installation and how to run the test suite.
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.
Source Distribution
Built Distribution
File details
Details for the file nbresuse-0.4.0.tar.gz
.
File metadata
- Download URL: nbresuse-0.4.0.tar.gz
- Upload date:
- Size: 11.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post20201107 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e9244f11fe5e39e07fda320f0658452afde4afd3c75fd641acd8664793fc068 |
|
MD5 | 6428c106ec12f98d1fce9932bf260f1e |
|
BLAKE2b-256 | 9220c652e11b12874222db2214fc2cbb86e83c45b9f2d8f49b27910328824893 |
Provenance
File details
Details for the file nbresuse-0.4.0-py2.py3-none-any.whl
.
File metadata
- Download URL: nbresuse-0.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 13.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post20201107 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 862311d19e78e610ebc99d75d40f607d53e27e2fa33f2488f7221678a09ea920 |
|
MD5 | 32aba97ee6bf1204f0b7d4debeefe9b7 |
|
BLAKE2b-256 | 5a1bd33b3baea11694b604705b8409fc2c547fe029ec5947406f3bd061763fe1 |