安装 | 配置 | 显示的资源 | 贡献

NBResuse

NB 资源使用（NBResuse）是 Jupyter Notebooks 的小型扩展，它显示了当前笔记本服务器及其子项（内核、终端等）使用的资源量。这显示在笔记本本身的主工具栏中，每5秒刷新一次。

安装

您目前可以从 PyPI 安装此软件包。

pip install nbresuse

如果您的笔记本版本小于 5.3，您需要手动启用扩展。

jupyter serverextension enable --py nbresuse --sys-prefix
jupyter nbextension install --py nbresuse --sys-prefix
jupyter nbextension enable --py nbresuse --sys-prefix

配置

内存限制

nbresuse 可以显示内存限制（但不能强制执行）。您可以通过以下几种方式设置此限制

1. MEM_LIMIT 环境变量。如果您使用支持此功能的孵化器，则 JupyterHub 将设置此变量。
2. 在启动 jupyter notebook 命令行时，作为 --ResourceUseDisplay.mem_limit。
3. 在您的 Jupyter notebook traitlets 配置文件中

限制需要以字节为单位的整数设置。

内存使用警告阈值

当用户接近内存限制时，资源显示的背景可以变为红色。此警告阈值的阈值可以配置为内存限制的分数。

如果您想在用户接近内存限制的10%时闪现警告，您可以设置参数 --ResourceUseDisplay.mem_warning_threshold=0.1。

CPU 使用率

nbresuse 还可以跟踪 CPU 使用率，并在 /metrics 响应中报告 cpu_percent 值。

您可以通过以下几种方式设置 cpu_limit

1. CPU_LIMIT 环境变量。如果您使用支持此功能的孵化器，则 JupyterHub 将设置此变量。
2. 在启动 jupyter notebook 命令行时，作为 --ResourceUseDisplay.cpu_limit。
3. 在您的 Jupyter notebook traitlets 配置文件中

此限制对应于用户可访问的 CPU 数量，但不能强制执行。

此外，您还可以设置 track_cpu_percent 特性以启用 CPU 使用率跟踪（默认禁用）

c = get_config()
c.NotebookApp.ResourceUseDisplay.track_cpu_percent = True

作为命令行参数

jupyter notebook --ResourceUseDisplay.track_cpu_percent=True

显示的资源

当前服务器扩展仅报告内存使用（仅 RSS）和 CPU 使用率。根据需要，将在未来添加其他指标。

笔记本扩展当前不显示 CPU 使用率，仅显示内存使用率。

贡献

如果您想为此项目做出贡献，请阅读 CONTRIBUTING.md。该文件解释了如何设置开发安装和如何运行测试套件。