diff --git a/README.md b/README.md index 7fa613a..d109b7a 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,12 @@ Kernel resource usage can be displayed in a sidebar for IPython kernels with 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. +enough to click `tachometer` icon on the right sidebar. + +If you want to show or hide information from the Kernel Usage sidebar +you can set `show_host_usage=False` to hide `Host CPU` and `Host Virtual Memory` 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: @@ -143,6 +148,11 @@ causes "lag"/pauses in the UI. To workaround this you can disable Prometheus met --ResourceUseDisplay.enable_prometheus_metrics=False ``` +### Show or Hide information from sidebar (tachometer) +If you want to show or hide 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`. + ## Enable alternative frontend By default, the alternative frontend is disabled. To enable it, users should go to diff --git a/doc/kernel-usage-limited-info.png b/doc/kernel-usage-limited-info.png new file mode 100644 index 0000000..0a549b2 Binary files /dev/null and b/doc/kernel-usage-limited-info.png differ