Skip to content

Commit

Permalink
updates readme with show_host_usage feature
Browse files Browse the repository at this point in the history
  • Loading branch information
pinksi committed Oct 6, 2023
1 parent e6f707b commit ce7cffa
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
Binary file added doc/kernel-usage-limited-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ce7cffa

Please sign in to comment.