mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
Update to jupyter-resource-usage
This commit is contained in:
@@ -4,7 +4,7 @@
|
|||||||
Check your memory usage
|
Check your memory usage
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
The `nbresuse <https://github.com/yuvipanda/nbresuse>`_ extension is part of
|
The `jupyter-resource-usage <https://github.com/jupyter-server/jupyter-resource-usage>`_ extension is part of
|
||||||
the default installation, and tells you how much memory your user is using
|
the default installation, and tells you how much memory your user is using
|
||||||
right now, and what the memory limit for your user is. It is shown in the
|
right now, and what the memory limit for your user is. It is shown in the
|
||||||
top right corner of the notebook interface. Note that this is memory usage
|
top right corner of the notebook interface. Note that this is memory usage
|
||||||
@@ -12,4 +12,4 @@ for everything your user is running through the Jupyter notebook interface,
|
|||||||
not just the specific notebook it is shown on.
|
not just the specific notebook it is shown on.
|
||||||
|
|
||||||
.. image:: ../../images/nbresuse.png
|
.. image:: ../../images/nbresuse.png
|
||||||
:alt: Memory limit / usage shown with nbresuse
|
:alt: Memory limit / usage shown with jupyter-resource-usage
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
.. _howto/admin/resize:
|
.. _howto/admin/resize:
|
||||||
|
|
||||||
=================================================
|
=================================================
|
||||||
Resize the resources available to your JupyterHub
|
Resize the resources available to your JupyterHub
|
||||||
=================================================
|
=================================================
|
||||||
|
|
||||||
As you are using your JupyterHub, you may need to increase or decrease
|
As you are using your JupyterHub, you may need to increase or decrease
|
||||||
the amount of resources allocated to your TLJH install. The kinds of resources that can be
|
the amount of resources allocated to your TLJH install. The kinds of resources that can be
|
||||||
allocated, as well as the process to do so, will depend on the provider / interface for your
|
allocated, as well as the process to do so, will depend on the provider / interface for your
|
||||||
VM. We recommend consulting the installation page for your provider for more information. This
|
VM. We recommend consulting the installation page for your provider for more information. This
|
||||||
@@ -18,12 +18,12 @@ Currently there are instructions to resize your resources on the following provi
|
|||||||
Once resources have been reallocated, you must tell TLJH to make use of these resources,
|
Once resources have been reallocated, you must tell TLJH to make use of these resources,
|
||||||
and verify that the resources have become available.
|
and verify that the resources have become available.
|
||||||
|
|
||||||
Verifying a Resize
|
Verifying a Resize
|
||||||
==================
|
==================
|
||||||
|
|
||||||
#. Once you have resized your server, tell the JupyterHub to make use of
|
#. Once you have resized your server, tell the JupyterHub to make use of
|
||||||
these new resources. To accomplish this, follow the instructions in
|
these new resources. To accomplish this, follow the instructions in
|
||||||
:ref:`topic/tljh-config` to set new memory or CPU limits and reload the hub. This can be completed
|
:ref:`topic/tljh-config` to set new memory or CPU limits and reload the hub. This can be completed
|
||||||
using the terminal in the JupyterHub (or via SSH-ing into your VM and using this terminal).
|
using the terminal in the JupyterHub (or via SSH-ing into your VM and using this terminal).
|
||||||
|
|
||||||
#. TLJH configuration options can be verified by viewing the tljh-config output.
|
#. TLJH configuration options can be verified by viewing the tljh-config output.
|
||||||
@@ -36,14 +36,14 @@ Verifying a Resize
|
|||||||
|
|
||||||
#. **To verify changes to memory**, confirm that it worked by starting
|
#. **To verify changes to memory**, confirm that it worked by starting
|
||||||
a new server (if you had one previously running, click "Control Panel -> Stop My Server" to
|
a new server (if you had one previously running, click "Control Panel -> Stop My Server" to
|
||||||
shut down your active server first), opening a notebook, and checking the value of the
|
shut down your active server first), opening a notebook, and checking the value of the
|
||||||
`nbresuse <https://github.com/yuvipanda/nbresuse>`_ extension in the upper-right.
|
`jupyter-resource-usage <https://github.com/jupyter-server/jupyter-resource-usage>`_ extension in the upper-right.
|
||||||
|
|
||||||
.. image:: ../../images/nbresuse.png
|
.. image:: ../../images/nbresuse.png
|
||||||
:alt: nbresuse demonstration
|
:alt: jupyter-resource-usage demonstration
|
||||||
|
|
||||||
#. **To verify changes to CPU**, use the ``nproc`` from a terminal.
|
#. **To verify changes to CPU**, use the ``nproc`` from a terminal.
|
||||||
This command displays the number of available cores, and should be equal to the
|
This command displays the number of available cores, and should be equal to the
|
||||||
number of cores you selected in your provider's interface.
|
number of cores you selected in your provider's interface.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|||||||
@@ -62,10 +62,10 @@ stop, unlike with RAM.
|
|||||||
|
|
||||||
Recommended\, CPU = (Max\, concurrent\, users \times Max\, CPU\, usage\, per\, user) + 20\%
|
Recommended\, CPU = (Max\, concurrent\, users \times Max\, CPU\, usage\, per\, user) + 20\%
|
||||||
|
|
||||||
The ``20%`` is overhead for TLJH and related services. This is around 20% of a
|
The ``20%`` is overhead for TLJH and related services. This is around 20% of a
|
||||||
single modern CPU. This, of course, is just an estimate. We recommend using
|
single modern CPU. This, of course, is just an estimate. We recommend using
|
||||||
the same process used to estimate Memory required for estimating CPU required.
|
the same process used to estimate Memory required for estimating CPU required.
|
||||||
You cannot use nbresuse for this, but you should carry out normal workflow and
|
You cannot use jupyter-resource-usage for this, but you should carry out normal workflow and
|
||||||
investigate the CPU usage on the machine.
|
investigate the CPU usage on the machine.
|
||||||
|
|
||||||
Disk space
|
Disk space
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ def test_serverextensions():
|
|||||||
'jupyterlab 3.',
|
'jupyterlab 3.',
|
||||||
'nbgitpuller 0.9.',
|
'nbgitpuller 0.9.',
|
||||||
'nteract_on_jupyter 2.1.',
|
'nteract_on_jupyter 2.1.',
|
||||||
'nbresuse '
|
'jupyter-resource-usage '
|
||||||
]
|
]
|
||||||
|
|
||||||
for e in extensions:
|
for e in extensions:
|
||||||
@@ -33,7 +33,7 @@ def test_nbextensions():
|
|||||||
], stderr=subprocess.PIPE, stdout=subprocess.PIPE)
|
], stderr=subprocess.PIPE, stdout=subprocess.PIPE)
|
||||||
|
|
||||||
extensions = [
|
extensions = [
|
||||||
'nbresuse/main',
|
'jupyter-resource-usage/main',
|
||||||
# This is what ipywidgets nbextension is called
|
# This is what ipywidgets nbextension is called
|
||||||
'jupyter-js-widgets/extension'
|
'jupyter-js-widgets/extension'
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ nteract-on-jupyter==2.1.*
|
|||||||
# Install jupyterlab extensions from PyPI
|
# Install jupyterlab extensions from PyPI
|
||||||
# nbgitpuller for easily pulling in Git repositories
|
# nbgitpuller for easily pulling in Git repositories
|
||||||
nbgitpuller==0.9.*
|
nbgitpuller==0.9.*
|
||||||
# nbresuse to show people how much RAM they are using
|
# jupyter-resource-usage to show people how much RAM they are using
|
||||||
nbresuse==0.3.*
|
jupyter-resource-usage==0.5.*
|
||||||
# Most people consider ipywidgets to be part of the core notebook experience
|
# Most people consider ipywidgets to be part of the core notebook experience
|
||||||
ipywidgets==7.6.*
|
ipywidgets==7.6.*
|
||||||
# Pin tornado
|
# Pin tornado
|
||||||
|
|||||||
Reference in New Issue
Block a user