zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for nbresuse

Browse Source
This commit is contained in:
yuvipanda
2018-08-05 09:44:28 -07:00
parent 907d2b8f5b
commit b5be59eae0
4 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/howto/nbresuse.rst Normal file
View File

@@ -0,0 +1,15 @@
.. _howto/nbresuse:
=======================
Check your memory usage
=======================
The `nbresuse <https://github.com/yuvipanda/nbresuse>`_ extension is part of
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
top right corner of the notebook interface. Note that this is memory usage
for everything your user is running through the Jupyter notebook interface,
not just the specific notebook it is shown on.
.. image:: ../images/nbresuse.png
:alt: Memory limit / usage shown with nbresuse

10
docs/howto/resource-estimation.rst
View File

@@ -40,16 +40,14 @@ Maximum memory allowed per user
Depending on what kinda work your users are doing, they will use different amounts Depending on what kinda work your users are doing, they will use different amounts
of memory. The easiest way to determine this is to run through a typical user of memory. The easiest way to determine this is to run through a typical user
workflow yourself, and measure how much memory is used. workflow yourself, and measure how much memory is used. You can use :ref:`howto/nbresuse`
to determine how much memory your user is using.
For example, you can begin running a Jupyter Notebook session on your JupyterHub, then open a A good rule of thumb is to take the maximum amount of memory you used during
terminal on the JupyterHub and use ``top`` to track how much memory you use
as you go through the material. A good rule of thumb is to take the maximum amount of memory you used during
your session, and add 20-40% headroom for users to 'play around'. This is the your session, and add 20-40% headroom for users to 'play around'. This is the
maximum amount of memory that should be given to each user. maximum amount of memory that should be given to each user.
If users use *more* than this alloted amount of memory, their kernel will restart (and all If users use *more* than this alloted amount of memory, their notebook kernel will restart.
their progress in the current session will be lost).
CPU CPU
=== ===

BIN
docs/images/nbresuse.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.5 KiB

1
docs/index.rst
View File

@@ -61,6 +61,7 @@ How-To guides answer the question 'How do I...?' for a lot of topics.
howto/share-data howto/share-data
howto/notebook-interfaces howto/notebook-interfaces
howto/resource-estimation howto/resource-estimation
howto/nbresuse
Authentication Authentication
-------------- --------------