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.0a210428.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e69345f5db582df7d61c89b27972629f4963941a9d66a4843b9456fdb6689605 |
|
MD5 | 73dccc8302c74123801138fd977ff034 |
|
BLAKE2b-256 | ff5e02e43e9a0d030c071e182b5af141545b666b586235fe740f53976e135a90 |
Hashes for jupyterlab_nvdashboard-0.5.0a210428-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42b50ae27b1650951157ce382a0001f6d777824733856a6d835a187a95c80f78 |
|
MD5 | 9cfdff525fc486b23be0edd39cbd9c09 |
|
BLAKE2b-256 | 08eaad526d1e59c7f515e256217cda5cd24fc77a3ff079be1790109f3528465f |