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.0a210502.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a208adce3e505f6d3e7eda0046f521a799d06c1e40d819f8ec3cb382dacf956 |
|
MD5 | e516934d53a8bfa27c1ca82be0c424a8 |
|
BLAKE2b-256 | 2f7f621c99cf07efb863c7f97c59d2ca5ed36bda60f11a2a8cfbe2d01b8eeb13 |
Hashes for jupyterlab_nvdashboard-0.5.0a210502-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27dfa2a2d4b87e18ca3d5ed36c61a2b2ed28922520fb00ce7952e521ad34914a |
|
MD5 | 7e0e42a153cb4e95ed76a6f33e564a20 |
|
BLAKE2b-256 | dc8892c95d9af44b98948d530e10af2d7054ad1f934e4e6f06f9fb631db4ccc5 |