A JupyterLab extension for displaying dashboards of GPU usage.
Project description
JupyterLab GPU Dashboards
A JupyterLab extension for displaying dashboards of GPU usage.
Built with JupyterLab and Bokeh Server
What's here
This repository contains two sets of code:
- Python code defining a Bokeh Server application that generates the dashboards
in the
jupyterlab_nvdashboard/
directory - TypeScript code integrating these dashboards into JupyterLab in the
src/
directory
You should be able to modify only the Python code to edit the dashboards without modifying the TypeScript code.
Prerequisites
- JupyterLab 1.0
- bokeh
- pynvml
Installation
This extension has a server-side (Python) and a client-side (Typescript) component, and we must install both in order for it to work.
Note: Currently nvdashboard does not support Windows
To install the server-side component, run the following in your terminal
pip install jupyterlab-nvdashboard
To install the client-side component, run
jupyter labextension install jupyterlab-nvdashboard
Development
To install the server-side part, run the following in your terminal from the repository directory:
pip install -e .
In order to install the client-side component (requires node version 8 or later), run the following in the repository directory:
jlpm install
jlpm run build
jupyter labextension install .
To rebuild the package and the JupyterLab app:
jlpm run build
jupyter lab build
Publishing
This application is distributed as two subpackages.
The JupyterLab frontend part is published to npm, and the server-side part to both PyPI and Anaconda (nightlies).
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.
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
Hashes for jupyterlab-nvdashboard-0.5.0a210501.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4407eb100c47a647f87eadacc883eb63741a692e330f5ce393f30e0312f4bad1 |
|
MD5 | 56be2cd29eacaab102aa4ac8632e776e |
|
BLAKE2b-256 | 42ddf2dec9b25f2aff0647539a7d3cbf140679fe142769438e5df671650b8fd5 |
Hashes for jupyterlab_nvdashboard-0.5.0a210501-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76c4583af4c9bf7043c79deecb9fffeea92dce74d9ca7c29f2edebce1e9d8af2 |
|
MD5 | 7fb44b568d79dbc79cbe66ad0cf424a2 |
|
BLAKE2b-256 | c4f607187f1b0ecc623708240e446d4763d4885002f7fce206bc6493a91db523 |