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.0a210430.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5ed8d68c4a59a4cc73b5758ed6348da55d6d601e26b1da20d71b802a7725374 |
|
MD5 | 7c9ab1f90ed73dc8fbdb7427ee6fe1e4 |
|
BLAKE2b-256 | 41cfac57104ad1a37f3054e4b3a190691667c351ceaeed461474d2f6ff7101b9 |
Hashes for jupyterlab_nvdashboard-0.5.0a210430-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 526bf300424245727443724c8460b33fbd8c69199e5aa039d1c44739cb59e449 |
|
MD5 | 81558e0cee8e2ade9f9d0afb5db25862 |
|
BLAKE2b-256 | 785c0a32c1929218d1c5f5a6bd6215666d0f52352682149f6937f571df21eeb0 |