From a81364d9354a14e60dc5cb5292ddbcfd9665373b Mon Sep 17 00:00:00 2001 From: Tara Charter Date: Fri, 4 Oct 2024 09:33:42 -0500 Subject: [PATCH] Docs: describe data files apptainer eng-det-oncall-support 3 Oct 2024 --- docs/setup-cluster/slurm/singularity.rst | 45 ++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/docs/setup-cluster/slurm/singularity.rst b/docs/setup-cluster/slurm/singularity.rst index 0c9722fac321..93abefcdcd60 100644 --- a/docs/setup-cluster/slurm/singularity.rst +++ b/docs/setup-cluster/slurm/singularity.rst @@ -248,3 +248,48 @@ You can view the current set of Docker image names in the cache with the ``-l`` .. code:: bash manage-enroot-cache -s /shared/enroot -l + +.. _singularity-apptainer-shells: + +****************************** + Singularity/Apptainer Shells +****************************** + +When using Determined AI with Singularity/Apptainer for interactive shells, there are some important +behaviors to understand, particularly regarding home directories and file locations. + +Home Directory Binding +====================== + +Singularity/Apptainer automatically binds the user's home directory to the container. This means: + +- When you start a shell, you will be placed in your actual system home directory, not in the + working directory where files are copied. +- This behavior differs from Docker containers and can be confusing if you're expecting to see your + files immediately. + +File Locations +============== + +When using the ``det shell start`` command with the ``-c`` option: + +- Files are correctly copied to the container, typically to ``/run/determined/train/model/``. +- Due to the home directory binding, you won't see these files in your initial working directory. +- To access your files, navigate to ``/run/determined/train/model/`` once your shell starts. + +Usage Example +============= + +To start a shell and access your copied files: + +.. code:: bash + + det shell start --config-file config.yaml -c . + cd /run/determined/train/model + +.. note:: + + Remember that your initial working directory will be your home directory, not where the files + were copied. Always navigate to the correct directory to find your copied files. + +For more information on shell configuration options, refer to :ref:`command-notebook-configuration`.