docs: improve Notebook docs
@@ -9,12 +9,21 @@ learning models, visualize the behavior of trained models, or even manage the tr
a model manually. Determined makes it easy to launch and manage notebooks.
Determined will schedule a Jupyter notebook in a containerized environment on the cluster and proxy
-HTTP requests to and from the notebook container through the Determined master. The lifecycle
-management of Jupyter notebooks in Determined is left up to the user---once a Jupyter notebook has
-been scheduled onto the cluster, it will remain scheduled indefinitely until the user explicitly
-shuts down the notebook. Once a notebook has been terminated, it is not possible to reactivate it.
-However, *new* notebooks can easily be configured to restore the state of a previous notebook---see
-:ref:`notebook-state` for more information.
+HTTP requests to and from the notebook container through the Determined master.
+
+The lifecycle management of Jupyter notebooks in Determined is left up to the user---once a Jupyter
+notebook has been scheduled onto the cluster, it will remain scheduled indefinitely until the user
+explicitly shuts down the notebook. Once a notebook has been terminated, it is not possible to
+reactivate it.
+
+Because Notebooks use a containerized environment, unless they are configured to use a shared file
+system, they cannot persist files that are modified within the container. See :ref:`notebook-state`
+for more information.
+
+.. warning::
+
+ Notebooks do not persist files by default. If a failure occurs (e.g., the agent hosting the
+ notebook crashes), the content of the Notebook will not be saved.
************************
Working with Notebooks
@@ -50,12 +59,6 @@ configuration file.
For more information on how to write the notebook configuration file, see
:ref:`notebook-configuration`.
-.. warning::
-
- In Determined, notebook state is not persistent by default. If a failure occurs (e.g., the agent
- hosting the notebook crashes), the content of the notebook will not be saved. To ensure that
- notebook state is persisted, refer to :ref:`notebook-state` for more information.
-
Other Useful Commands
---------------------
@@ -164,6 +167,9 @@ To ensure that your work is saved even if your notebook gets terminated, it is r
all notebooks with a shared filesystem directory *bind-mounted* into the notebook container and work
on files inside of the bind mounted directory.
+By default, clusters that are launched by ``det deploy aws/gcp up`` create a Network file system
+that is shared by all the agents and automatically mounted into Notebook containers.
+
For example, a user ``jimmy`` with a shared filesystem home directory at ``/shared/home/jimmy``
could use the following configuration to launch a notebook:
