Skip to content

Commit ec115fd

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

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,13 @@ 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 hide information from the Kernel Usage sidebar
32+
you can set `--ResourceUseDisplay.show_host_usage=False` to hide `Host CPU` and `Host Virtual Memory` information. The default is
33+
set as `True`, i.e. show all the information.
34+
35+
![Screenshot for kernel usage with limited info](./doc/kernel-usage-limited-info.png)
3036

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

doc/kernel-usage-limited-info.png

20 KB
Loading

0 commit comments

Comments
 (0)