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
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.0a200819.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1bef8ec52b21d8c2dc94276a5fb5ffbb5e602efb63d4b635ef74931262395a5 |
|
MD5 | f761d8c081e270330e010f04e2680a4f |
|
BLAKE2b-256 | 6c4f8462ef57ed28f5d4bc3046853bb8f4ca385ee91a051722066c124933309d |
Hashes for jupyterlab_nvdashboard-0.5.0a200819-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecd965e66c53ebf4e535596ed96219b1043638e3008aecb5d8f337abc382e5f7 |
|
MD5 | 1b977efc197245970991d3b27fd25006 |
|
BLAKE2b-256 | e60507977ac3e63dbd1afa3c9ab3c15db8ac804724fb3bd08c8b977341008caf |