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.3.0a200420.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c86912cecf52cd52da4fb75164cd01d1e5e04d5b0ce52b621bc1083b3b44b0a9 |
|
MD5 | 1afa605c4959dc04a85b66d6bbae0b5f |
|
BLAKE2b-256 | eb8e993186f2e6863f701b4bd1aae9a8a123bcd2ab7d04a91c07aa4265878b93 |
Hashes for jupyterlab_nvdashboard-0.3.0a200420-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e240daf65374f3af6eef09ad920c199c9b39e74ec25b8c9fc4ebffdafd6d4c8c |
|
MD5 | 892f51c419b5acd00701ac41d05d7f4f |
|
BLAKE2b-256 | cc791c4328a7d051cf6703e08a8d8118870be74e87f722fde43dc69b5d7d17e0 |