Skip to main content

A JupyterLab extension for displaying GPU usage dashboards

Project description

JupyterLab NVdashboard

NVDashboard is a JupyterLab extension for displaying GPU usage dashboards. It enables JupyterLab users to visualize system hardware metrics within the same interactive environment they use for development. Supported metrics include:

  • GPU-compute utilization
  • GPU-memory consumption
  • PCIe throughput
  • NVLink throughput

Demo

JupyterLab-nvdashboard Demo

Table of Contents

New Features

JupyterLab-nvdashboard v4 brings a host of new features, improved backend architecture, and enhanced frontend components for an even better user experience. Explore the exciting updates below.

Brush for Time Series Charts

Introducing a powerful brushing feature for time series charts. Users can easily inspect past events by selecting a specific time range, providing more granular control over data exploration.

JupyterLab-nvdashboard Demo1

Synced Tooltips

For pages with multiple charts, JupyterLab-nvdashboard now offers synchronized tooltips for timestamps across all charts. This feature enhances the user's ability to analyze data cohesively and understand relationships between different data points.

JupyterLab-nvdashboard Demo4

Theme Compatibility

Seamless integration with JupyterLab themes is now a reality. The extension adapts its colors and aesthetics based on whether the user is in a light or dark theme, ensuring a consistent and visually appealing experience.

Light Theme

JupyterLab-nvdashboard Demo3

Dark Theme

JupyterLab-nvdashboard Demo2

Version Compatibility

JupyterLab-nvdashboard v4 is designed exclusively for JupyterLab v4 and later versions. To ensure continued support for JupyterLab v3 users, we will maintain the previous version separately (branch-0.9).

Requirements

  • JupyterLab >=4
  • pynvml
  • psutil

Installation

Conda

# nightly version (for jupyterlab>=4)
conda install -c rapidsai-nightly -c conda-forge jupyterlab-nvdashboard

# stable version (for jupyterlab<4)
conda install -c rapidsai -c conda-forge jupyterlab-nvdashboard

PyPI

# nightly version (for jupyterlab>=4)
pip install --extra-index-url https://pypi.anaconda.org/rapidsai-wheels-nightly/simple --pre jupyterlab_nvdashboard

# stable version (for jupyterlab<4)
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 Developers Guide

For more details, check out the contributing guide.

Future Improvements

While we've introduced a range of exciting features in this release, we understand that there are always opportunities for improvement. We have noted a request to add cell execution markers to the charts. Due to the complexities associated with asynchronous cells, we have decided to defer this feature to a future update. Rest assured, we will explore this enhancement in subsequent releases.

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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

jupyterlab_nvdashboard-0.10.0-py3-none-any.whl (172.4 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_nvdashboard-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_nvdashboard-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ad7c8a4ac14075ce9fb40c994110f95f753289b7277ca2b0c3fbf403cc340c4
MD5 1dd6c037ab6f00650caa1a68af41a952
BLAKE2b-256 83879f22b25e31cca16ef93ec56b7b83f688a09ec7e55be3807c232fdd1774b8

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