Skip to content

Commit ce7cffa

Browse files
committed
updates readme with show_host_usage feature
1 parent e6f707b commit ce7cffa

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,12 @@ Kernel resource usage can be displayed in a sidebar for IPython kernels with
2626

2727
The kernel usage is available for Notebook 7.x too which can be enabled at
2828
`View -> Right Sidebar -> Show Kernel Usage`. In the case of JupyterLab interface, it is
29-
enough to click `tachometer` icon on the right sidebar.
29+
enough to click `tachometer` icon on the right sidebar.
30+
31+
If you want to show or hide information from the Kernel Usage sidebar
32+
you can set `show_host_usage=False` to hide `Host CPU` and `Host Virtual Memory` information.
33+
34+
![Screenshot for kernel usage with limited info](./doc/kernel-usage-limited-info.png)
3035

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

@@ -143,6 +148,11 @@ causes "lag"/pauses in the UI. To workaround this you can disable Prometheus met
143148
--ResourceUseDisplay.enable_prometheus_metrics=False
144149
```
145150

151+
### Show or Hide information from sidebar (tachometer)
152+
If you want to show or hide information from the Kernel Usage sidebar
153+
you can set `--ResourceUseDisplay.show_host_usage=False` to hide `Host CPU` and `Host Virtual Memory` information. The default is
154+
set as `True`.
155+
146156
## Enable alternative frontend
147157

148158
By default, the alternative frontend is disabled. To enable it, users should go to

doc/kernel-usage-limited-info.png

20 KB
Loading

0 commit comments

Comments
 (0)