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.0a210415.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76e4af93cfb1566c23ad4c69538ab85dd4b2e6624747b94cf8745814f6e0587c |
|
MD5 | cd1f0dd3c0a41d42b6859c33caeeb615 |
|
BLAKE2b-256 | e9b5ef1a45d624fd39f296006b7113418e7d4ca59775b706e9a2892e9b814d59 |
Hashes for jupyterlab_nvdashboard-0.5.0a210415-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad6ab2c0e27ffa6e70d22bfe21b87d284f361668464d8c57fc41e1a7bfcb4cb5 |
|
MD5 | f5c7ce1e8252a82677f8c9547ca9072e |
|
BLAKE2b-256 | ff4f6f91f2a22052e08711e1b9ee9d8b8491e9ae48a9487f18713a6d20cbd0b6 |