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
File details
Details for the file jupyterlab-nvdashboard-0.5.0a210414.tar.gz.
File metadata
- Download URL: jupyterlab-nvdashboard-0.5.0a210414.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ffb5fce7c9b74c393151785531f01f82dcaad0233be751bdb6a47632622d1ea5 |
|
| MD5 | 1d7e36dda015cd73452a28f965e6aeb2 |
|
| BLAKE2b-256 | f0606a7ac1215c93ae871e79ceca237c84ca79c077a6e0f18c76fb8673a557e4 |
File details
Details for the file jupyterlab_nvdashboard-0.5.0a210414-py3-none-any.whl.
File metadata
- Download URL: jupyterlab_nvdashboard-0.5.0a210414-py3-none-any.whl
- Upload date:
- Size: 10.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | aa9c8d205ce11ba8fb392befd1a9bc4f15693065023c3be3e6518e2c45d3929f |
|
| MD5 | ecc99a2e923642a790d69a6edc6aea07 |
|
| BLAKE2b-256 | 46bc099af03e083f8f17b08ca63148aed0e916753261c999912fceb214619cba |
