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.0a210427.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c16056dbdb96d4230041055a31b20eefee83604b5eb01faae814ece75e880cd8 |
|
MD5 | 8366a605b4157981ac0501e6b3c8ba20 |
|
BLAKE2b-256 | 82803d13cfa78c7007920d33328e7c87e7dd4e00560ad8425ea34779ba14c545 |
Hashes for jupyterlab_nvdashboard-0.5.0a210427-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6638b02ec021a5c1d947f0aa99126595a0a77c4520eb6197d2996e108af090d5 |
|
MD5 | 8bed74ead778844564e34b6716f0cf12 |
|
BLAKE2b-256 | 506cdda7e10f1e0efc5ccff470333737203eb56d3d2d37f343acb2e37c23d384 |