A JupyterLab extension for displaying GPU usage dashboards
Project description
JupyterLab NVDashboard
NVDashboard is a JupyterLab extension for displaying GPU usage dashboards. It enables JupyterLab users to visualize system hardware metrics within the same interactive environment they use for development. Supported metrics include:
- GPU-compute utilization
- GPU-memory consumption
- PCIe throughput
- NVLink throughput
This extension is composed of a Python package named jupyterlab_nvdashboard
for the server extension and a NPM package named jupyterlab-nvdashboard
for the frontend extension.
Requirements
- JupyterLab >= 3.0
Install
pip install jupyterlab_nvdashboard
Troubleshoot
If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:
jupyter server extension list
If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:
jupyter labextension list
Contributing
Development install
Note: You will need NodeJS to build the extension package.
The jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
yarn or npm in lieu of jlpm below.
# Clone the repo to your local environment
# Change directory to the jupyterlab_nvdashboard directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
jupyter lab build --minimize=False
Uninstall
pip uninstall jupyterlab_nvdashboard
Releases for both packages are handled by gpuCI. Nightly builds are triggered when a push to a versioned branch occurs (i.e. branch-0.5). Stable builds are triggered when a push to the main branch occurs.
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 jupyterlab_nvdashboard-0.9.0a3.tar.gz.
File metadata
- Download URL: jupyterlab_nvdashboard-0.9.0a3.tar.gz
- Upload date:
- Size: 27.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cf309bdfa0c9f7ad924b6b7b1afa9281bb5c364744a38be787cfc9067972e46a |
|
| MD5 | c1f61dcb3f0abbda3296f0795ae1b62e |
|
| BLAKE2b-256 | 35743901b5f34cab55643d57209ddc5375705eac4bf0a1a9ea12bbd75dda16e2 |
Provenance
File details
Details for the file jupyterlab_nvdashboard-0.9.0a3-py3-none-any.whl.
File metadata
- Download URL: jupyterlab_nvdashboard-0.9.0a3-py3-none-any.whl
- Upload date:
- Size: 37.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d59a68a8fbebd2ede8b0f384107c429a9c8b23cd8d09a4de30402a19b8782c42 |
|
| MD5 | b4c2093648f33c3307016b1611be7952 |
|
| BLAKE2b-256 | 8e870d118d2773c47c6061dd7c699232d6009080bede6eb199dcad969bab7f1b |
