Skip to content

Commit

Permalink
Move the addition to the configuration section
Browse files Browse the repository at this point in the history
  • Loading branch information
krassowski committed Aug 28, 2024
1 parent f33f53f commit 4a1dfe1
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,6 @@ The kernel usage is available for Notebook 7.x too which can be enabled at
`View -> Right Sidebar -> Show Kernel Usage`. In the case of JupyterLab interface, it is
enough to click `tachometer` icon on the right sidebar.

If you want to hide host information from the Kernel Usage sidebar
you can set `--ResourceUseDisplay.show_host_usage=False` to hide `Host CPU` and `Host Virtual Memory` information.
The default is set as `True`, i.e. show all the information.

![Screenshot for kernel usage with limited info](./doc/kernel-usage-limited-info.png)

The package provides an alternative frontend for the `jupyter-resource-usage` metrics:

![screencast](./doc/topbar.gif)
Expand Down Expand Up @@ -109,6 +103,14 @@ The threshold for this warning can be configured as a fraction of the memory lim
If you want to flash the warning to the user when they are within 10% of the memory limit, you
can set the parameter `--ResourceUseDisplay.mem_warning_threshold=0.1`.

### Host information

If you want to hide host information from the Kernel Usage sidebar
you can set `--ResourceUseDisplay.show_host_usage=False` to hide `Host CPU` and `Host Virtual Memory` information.
The default is set as `True`, i.e. show all the information.

![Screenshot for kernel usage with limited info](./doc/kernel-usage-limited-info.png)

### CPU Usage

`jupyter-resource-usage` can also track CPU usage and report a `cpu_percent` value as part of the `/api/metrics/v1` response.
Expand Down

0 comments on commit 4a1dfe1

Please sign in to comment.