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 PyPI.
Releases for both packages are done with the jlpm tool, git and Travis CI.
Note: Package versions are not prefixed with the letter v. You will need to disable this.
$ jlpm config set version-tag-prefix ""
Making a release
$ jlpm version [--major|--minor|--patch] # updates package.json and creates git commit and tag
$ git push && git push --tags # pushes tags to GitHub which triggers Travis CI to build and deploy
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.4.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ff12f20076e8cb52ea3319ccf148458ba6230611b52b835b0eeea10ba37f7fe1 |
|
| MD5 | b500b309016819a12678aa77cd19b048 |
|
| BLAKE2b-256 | b2ba83ca339dee6f0ea250f5ef9926c2b1ad4195cca1d0d62260a627813b7a7a |
Hashes for jupyterlab_nvdashboard-0.4.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e6ca78b94ea04a64034c63ecbc8cad0cfbea8ba5016619a2678acf1b2531b0f5 |
|
| MD5 | a3c11be2a0369bb391d1a223417aafa7 |
|
| BLAKE2b-256 | 816bda70d54513bf4ff6830e1bfbb47623c2260523fda5eacce9d932e4e97c7e |
