diff --git a/docs/apps/clearml_session.md b/docs/apps/clearml_session.md index 886375df..003fac79 100644 --- a/docs/apps/clearml_session.md +++ b/docs/apps/clearml_session.md @@ -143,23 +143,26 @@ The Task must be connected to a git repository, since currently single script de | `--packages`| Additional packages to add. Supports version numbers. Example: `--packages torch==1.7 tqdm` | Previously added packages.| | `--git-credentials` | If `True`, local `.git-credentials` file is sent to the interactive session.| `false`| | `--verbose ` | Increase verbosity of logging | `none` | -| `--docker`| Select the docker image to use in the interactive session on |`None` or previously used docker image| -| `--debugging` | Pass existing Task ID, create a copy of the experiment on a remote machine, and launch Jupyter/SSH for interactive access. Example `--debugging `| `none`| -| `--queue`| Select the queue to launch the interactive session on | Previously used queue| +| `--docker`| Select the docker image to use in the interactive session on |`nvidia/cuda:10.1-runtime-ubuntu18.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 | +| `--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`| +| `--queue`| Select the queue to launch the interactive session on | Previously used queue| | `--jupyter-lab` | Install a JupyterLab on interactive session | `true` | | `--vscode-server` | Install VSCode on interactive session | `true` | -| `--public-ip` | Register the public IP of the remote machine (if you are running the session on a public cloud) | Session runs on the machine whose agent is executing the session| +| `--vscode-version` | Set VSCode server (code-server) version, as well as VSCode python extension version (example: "3.7.4:2020.10.332292344")| `3.12.0:2021.10.1365161279`| +| `--public-ip` | If `true`, register the public IP of the remote machine (if you are running the session on a public cloud) | `false` - Session runs on the machine whose agent is executing the session| +| `--remote-ssh-port`| Set the remote SSH server port, running on the agent's machine | 10022| | `--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 | | `--user-folder` | Specify the path for the session's remote base folder for the session | Home folder(`~/`) or previously entered user folder path | | `--config-file` | Specify a path to another configuration file for `clearml-session` to store its previous state | `.clearml_session.json` or previously entered configuration file | | `--remote-gateway` | Specify a gateway IP to pass to the interactive session, if an external address needs to be accessed | `none`| | `--base-task-id` | Pass the ID of a task that will become the base task, so the session will use its configurations | `none` or the previously entered base task | -| `--disable-keepalive` | Disable transparent proxy that keep sockets alive to maintain the connection to the remote resource | `false` | +| `--keepalive` | If set, enables transparent proxy that keep sockets alive to maintain the connection to the remote resource | `false` - do not use transparent socket for mitigating connection drops | | `--queue-excluded-tag` | The queue option list will exclude queues with specified tags. See the `tags` parameter in the [queues.create](../references/api/queues.md#post-queuescreate) API call | `none` | | `--queue-include-tag` | The queue option list will include only queues with specified tags. See the `tags` parameter in the [queues.create](../references/api/queues.md#post-queuescreate) API call | `none` | | `--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`| | `--username`| Set your own SSH username for the interactive session | `root` or a previously used username | | `--password`| Set your own SSH password for the interactive session | A randomly generated password or a previously used one | +| `--version`| Display the clearml-session utility version| N/A| \ No newline at end of file