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.0a210429.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e2dfcfd37609e38a356fda04cc1040ca7aa16156de630739ef8a148a0b1a209 |
|
MD5 | 479c73be9a5a41c29921b78da9e34327 |
|
BLAKE2b-256 | f7c034eea63eaf008df2212cab462fbcad078c77e9220e57f79deaf580269599 |
Hashes for jupyterlab_nvdashboard-0.5.0a210429-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe52d5952af0494997b97e520e7469d91dd657cdc080f50197d89b31b8573d77 |
|
MD5 | ec2539173df255523bc851ae03890587 |
|
BLAKE2b-256 | c6090e9aad75ab282ce1bf1caa3ff53c40e4809a8e3cfda4fb5056ec9612ee8e |