From 4a1dfe178a2ad200bc82c77a391e9d0e16254143 Mon Sep 17 00:00:00 2001 From: krassowski <5832902+krassowski@users.noreply.github.com> Date: Wed, 28 Aug 2024 13:09:43 +0100 Subject: [PATCH] Move the addition to the configuration section --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 98bb885..e161376 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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.