Skip to main content

A JupyterLab extension for displaying GPU usage dashboards

Project description

jupyterlab_nvdashboard

Github Actions Status

A JupyterLab extension for displaying GPU usage dashboards

This extension is composed of a Python package named jupyterlab_nvdashboard for the server extension and a NPM package named jupyterlab-nvdashboard for the frontend extension.

Requirements

  • JupyterLab >= 3.0

Install

pip install jupyterlab_nvdashboard

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_nvdashboard directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

pip uninstall jupyterlab_nvdashboard

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

jupyterlab_nvdashboard-0.7.0a2107164.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file jupyterlab_nvdashboard-0.7.0a2107164.tar.gz.

File metadata

  • Download URL: jupyterlab_nvdashboard-0.7.0a2107164.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.10

File hashes

Hashes for jupyterlab_nvdashboard-0.7.0a2107164.tar.gz
Algorithm Hash digest
SHA256 9daa0fe2c2d956e6a7ea9704a4aa599606d27a3c7912f626acc476c9d7cc2894
MD5 37e1f2d4549ccb575b83c11b75d757e5
BLAKE2b-256 5eeddfe148552b2617b517017e982f2449765642b19bb8fc8b3d7dc4256e9e4b

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_nvdashboard-0.7.0a2107164-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_nvdashboard-0.7.0a2107164-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.7.10

File hashes

Hashes for jupyterlab_nvdashboard-0.7.0a2107164-py3-none-any.whl
Algorithm Hash digest
SHA256 5a0db964d5f1e7d7ded37ddb7d5bc037014570ce47b0a639ef48eb1f96a43b63
MD5 d72d4cde5b791cb1421804f171ed8fbc
BLAKE2b-256 b338136d11c5a960d5f9afbb2a5d218e2b5384a545d855a1cedb16ce03769080

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page