Description of image

How to View Gradient Resource Metrics

Notebooks are a web-based Jupyter IDE with shared persistent storage for long-term development and inter-notebook collaboration, backed by accelerated compute.


Gradient workloads can record metrics that are available both in real time or after the workload is complete. Gradient displays these metrics in the web UI and are queried or streamed in the CLI.

Gradient can log three different kinds of metrics which are hardware metrics, framework metrics, and custom user metrics.

Note
Framework and custom metrics are only available in a Gradient Private Cluster.

All Gradient workloads like Experiments and Deployments monitor and track CPU, memory, and networks. If the machine is equipped with a GPU, this is also tracked.

System Metrics showing CPU and Memory Usage

Viewing Notebook Metrics in the GUI

Note
Notebook metrics are a Gradient Private Cluster feature.

To view notebook metrics, you can see a minimal version in the notebook header and open a more detailed version if needed.

Detailed view

Viewing Metrics in the CLI

If you want to query the metrics for a given workload using the CLI, you could use the syntax below which uses Experiments. Deployments and Notebooks syntax is the same as the Experiments example below.

Usage: gradient experiments metrics [OPTIONS] COMMAND [ARGS]...

  Read experiment metrics

Options:
  --help  Show this message and exit.

Commands:
  get     Get experiment metrics
  stream  Watch live experiment metrics