From 0a4b6eaf5bd97c9c809210cc888c3fdb5bf06c0e Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Tue, 12 Mar 2024 11:26:00 +0200 Subject: [PATCH] Edit ClearML Session page (#798) --- docs/apps/clearml_session.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/apps/clearml_session.md b/docs/apps/clearml_session.md index b3612e48..2d55ffad 100644 --- a/docs/apps/clearml_session.md +++ b/docs/apps/clearml_session.md @@ -180,20 +180,20 @@ the remote session container, put all your code and data under the `` again and `clearml-session` will grab the previous workspace snapshot and restore it into the new remote container in ``. ```commandline -clearml-session --store-workspace ~/workspace --docker python:3.10-bullseye +clearml-session --store-workspace ~/workspace ``` To continue a specific session and restore its workspace, specify the session ID with `--continue-session `: ```commandline -clearml-session --continue-session --store-workspace ~/workspace --docker python:3.10-bullseye +clearml-session --continue-session --store-workspace ~/workspace ``` ### Command Line Options @@ -208,9 +208,9 @@ clearml-session --continue-session --store-workspace ~/workspace -- | `--continue-session` | Pass the session of a previous session to continue, restoring your workspace (see `--store-workspace`) | `none` | | `--debugging-session` | Pass existing Task ID, create a copy of the experiment on a remote machine, and launch Jupyter/SSH for interactive access. Example `--debugging-session `| `none`| | `--disable-session-cleanup` | If `True`, previous interactive sessions are not deleted | `false`| -| `--docker`| Select the docker image to use in the interactive session on |`nvidia/cuda:11.6.2-runtime-ubuntu20.04` or previously used docker image| +| `--docker`| Select the docker image to use in the interactive session |`nvidia/cuda:11.6.2-runtime-ubuntu20.04` or previously used docker image| | `--docker-args` | Add additional arguments for the docker image to use in the interactive session | `none` or the previously used docker-args | -| `--force_dropbear`| Force using `dropbear` instead of SSHd |`None`| +| `--force_dropbear`| Force using `dropbear` instead of SSHd |`none`| | `--git-credentials` | If `True`, local `.git-credentials` file is sent to the interactive session.| `false`| | `--init-script` | Specify a BASH init script file to be executed when the interactive session is being set up | `none` or previously entered BASH script | | `--jupyter-lab` | Install a JupyterLab on interactive session | `true` | @@ -227,16 +227,16 @@ clearml-session --continue-session --store-workspace ~/workspace -- | `--requirements`| Specify `requirements.txt` file to install when setting the interactive session. | `none` or previously used requirements (can be overridden by calling `--packages`)| | `--session-name` | Set the name of the interactive session Task| `none` | | `--session-tags` | Add tags to the interactive session for increased visibility | `none` | -| `--shell` | Open the SSH session directly. Notice, quiting the SSH session will not shut down the remote session|`None`| -| `--shutdowm`, `-S`| Shut down an active session | Previous session| +| `--shell` | Open the SSH session directly. Notice, quitting the SSH session will not shut down the remote session|`none`| +| `--shutdown`, `-S`| Shut down an active session | Previous session| | `--skip-docker-network` | Don't pass the `--network host` flag to the Docker that is launching the remote session. See [Networking using the host network](https://docs.docker.com/network/network-tutorial-host/) | `false`| -| `--store-workspace` | Upload/Restore remote workspace folder and extract it into next the session. Use with `--continue-session` to continue your previous work from your exact container state | `none` | -| `--upload-files`| Specify local files/folders to upload to the remote session|`None`| +| `--store-workspace` | Upload/Restore remote workspace folder and extract it into the next session. Use with `--continue-session` to continue your previous work from your exact container state | `none` | +| `--upload-files`| Specify local files/folders to upload to the remote session|`none`| | `--user-folder` | Specify the path for the session's remote base folder for the session | Home folder(`~/`) or previously entered user folder path | | `--username`| Set your own SSH username for the interactive session | `root` or a previously used username | | `--verbose` | Increase verbosity of logging | `none` | | `--version`| Display the clearml-session utility version| N/A| -| `--vscode-extensions` |Install additional VSCode extensions and VSCode python extensions (example: `ms-python.python,ms-python.black-formatter,ms-python.pylint,ms-python.flake8`)|`None`| +| `--vscode-extensions` |Install additional VSCode extensions and VSCode python extensions (example: `ms-python.python,ms-python.black-formatter,ms-python.pylint,ms-python.flake8`)|`none`| | `--vscode-server` | Install VSCode on interactive session | `true` | | `--vscode-version` | Set VSCode server (code-server) version, as well as VSCode python extension version (example: "3.7.4:2020.10.332292344")| `4.14.1:2023.12.0`| | `--yes`, `-y`| Automatic yes to prompts; assume "yes" as answer to all prompts and run non-interactively |N/A|