ClearML/clearml-session
1
0
Fork 0
mirror of https://github.com/clearml/clearml-session synced 2025-06-26 18:16:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update readme with new commands

Browse Source
This commit is contained in:
clearml 2025-04-20 15:55:05 +03:00
parent 6ea871c916
commit c97c939013
1 changed files with 52 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
README.md
View File

@ -258,6 +258,15 @@ clearml-session --debugging-session <experiment_id_here>
Click on the JupyterLab/VSCode link, or drop directly into an SSH shell by typing `shell`. Click on the JupyterLab/VSCode link, or drop directly into an SSH shell by typing `shell`.
### 👉 Remote session commands
While running inside the remote session, `clearml-session` adds the following commands to your shell:
- `shutdown` - calling the `shutdown` command, as the name suggests, will shut down the interactive SSH session.
- `clearml-sync-workspace` - calling this command will immediately upload your current workspace directory (see `--store-workspace` argument) to the ClearML configured storage (e.g. files server, S3 etc.).
Notice if this command does not exist this means the session does Not sync any local workspace.
## ❓ Frequently Asked Questions ## ❓ Frequently Asked Questions
#### How does it work? #### How does it work?
@ -306,21 +315,15 @@ clearml-session --help
```console ```console
clearml-session - CLI for launching JupyterLab / VSCode / SSH on a remote machine clearml-session - CLI for launching JupyterLab / VSCode / SSH on a remote machine
usage: clearml-session [-h] [--version] [--attach [ATTACH]] [--shutdown [SHUTDOWN]] [--shell] usage: clearml-session [-h] [--version] [--attach [ATTACH]] [--shutdown [SHUTDOWN]] [--shell] [--debugging-session DEBUGGING_SESSION] [--queue QUEUE] [--router-enabled [true/false]]
[--debugging-session DEBUGGING_SESSION] [--queue QUEUE] [--router-enabled] [--docker DOCKER] [--docker DOCKER] [--docker-args DOCKER_ARGS] [--public-ip [true/false]] [--remote-ssh-port REMOTE_SSH_PORT] [--vscode-server [true/false]]
[--docker-args DOCKER_ARGS] [--public-ip [true/false]] [--remote-ssh-port REMOTE_SSH_PORT] [--vscode-version VSCODE_VERSION] [--vscode-extensions VSCODE_EXTENSIONS] [--jupyter-lab [true/false]] [--upload-files UPLOAD_FILES]
[--vscode-server [true/false]] [--vscode-version VSCODE_VERSION] [--vscode-extensions VSCODE_EXTENSIONS] [--continue-session CONTINUE_SESSION] [--store-workspace STORE_WORKSPACE] [--git-credentials [true/false]] [--user-folder USER_FOLDER] [--packages [PACKAGES ...]]
[--jupyter-lab [true/false]] [--upload-files UPLOAD_FILES] [--continue-session CONTINUE_SESSION] [--requirements REQUIREMENTS] [--init-script [INIT_SCRIPT]] [--config-file CONFIG_FILE] [--remote-gateway [REMOTE_GATEWAY]] [--base-task-id BASE_TASK_ID]
[--store-workspace STORE_WORKSPACE] [--git-credentials [true/false]] [--user-folder USER_FOLDER] [--project PROJECT] [--session-name SESSION_NAME] [--session-tags [SESSION_TAGS ...]] [--disable-session-cleanup [true/false]] [--keepalive [true/false]]
[--packages [PACKAGES [PACKAGES ...]]] [--requirements REQUIREMENTS] [--init-script [INIT_SCRIPT]] [--queue-excluded-tag [QUEUE_EXCLUDED_TAG ...]] [--queue-include-tag [QUEUE_INCLUDE_TAG ...]] [--skip-docker-network [true/false]] [--password PASSWORD]
[--config-file CONFIG_FILE] [--remote-gateway [REMOTE_GATEWAY]] [--base-task-id BASE_TASK_ID] [--randomize [RANDOMIZE ...]] [--username USERNAME] [--force-dropbear [true/false]] [--disable-storage-packages [true/false]] [--disable-store-defaults]
[--project PROJECT] [--session-name SESSION_NAME] [--session-tags [SESSION_TAGS [SESSION_TAGS ...]]] [--disable-fingerprint-check] [--verbose] [--yes]
[--disable-session-cleanup [true/false]] [--keepalive [true/false]]
[--queue-excluded-tag [QUEUE_EXCLUDED_TAG [QUEUE_EXCLUDED_TAG ...]]]
[--queue-include-tag [QUEUE_INCLUDE_TAG [QUEUE_INCLUDE_TAG ...]]] [--skip-docker-network [true/false]]
[--password PASSWORD] [--randomize [RANDOMIZE [RANDOMIZE ...]]] [--username USERNAME]
[--force-dropbear [true/false]] [--disable-store-defaults] [--disable-fingerprint-check] [--verbose]
[--yes]
{list,info,shutdown} ... {list,info,shutdown} ...
clearml-session - CLI for launching JupyterLab / VSCode / SSH on a remote machine clearml-session - CLI for launching JupyterLab / VSCode / SSH on a remote machine
@ -331,7 +334,7 @@ positional arguments:
info Detailed information on specific session info Detailed information on specific session
shutdown Shutdown specific session shutdown Shutdown specific session
optional arguments: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--version Display the clearml-session utility version --version Display the clearml-session utility version
--attach [ATTACH] Attach to running interactive session (default: previous session) --attach [ATTACH] Attach to running interactive session (default: previous session)
@ -339,87 +342,76 @@ optional arguments:
Shut down an active session (default: previous session) Shut down an active session (default: previous session)
--shell Open the SSH shell session directly, notice quiting the SSH session will Not shutdown the remote session --shell Open the SSH shell session directly, notice quiting the SSH session will Not shutdown the remote session
--debugging-session DEBUGGING_SESSION --debugging-session DEBUGGING_SESSION
Pass existing Task id (experiment), create a copy of the experiment on a remote machine, and launch Pass existing Task id (experiment), create a copy of the experiment on a remote machine, and launch jupyter/ssh for interactive access. Example --debugging-session
jupyter/ssh for interactive access. Example --debugging-session <task_id> <task_id>
--queue QUEUE Select the queue to launch the interactive session on (default: previously used queue) --queue QUEUE Select the queue to launch the interactive session on (default: previously used queue)
--router-enabled If we have a clearml Router set, make sure we request direct TCP routing to our container. --router-enabled [true/false]
--docker DOCKER Select the docker image to use in the interactive session on (default: previously used docker image or If we have a clearml Router set, make sure we request direct TCP routing to our container.
`nvidia/cuda:11.6.2-runtime-ubuntu20.04`) --docker DOCKER Select the docker image to use in the interactive session on (default: previously used docker image or `nvidia/cuda:11.6.2-runtime-ubuntu20.04`)
--docker-args DOCKER_ARGS --docker-args DOCKER_ARGS
Add additional arguments for the docker image to use in the interactive session on (default: previously Add additional arguments for the docker image to use in the interactive session on (default: previously used docker-args)
used docker-args)
--public-ip [true/false] --public-ip [true/false]
If True register the public IP of the remote machine. Set if running on the cloud. Default: false (use If True register the public IP of the remote machine. Set if running on the cloud. Default: false (use for local / on-premises)
for local / on-premises)
--remote-ssh-port REMOTE_SSH_PORT --remote-ssh-port REMOTE_SSH_PORT
Set the remote ssh server port, running on the agent`s machine. (default: 10022) Set the remote ssh server port, running on the agent`s machine. (default: 10022)
--vscode-server [true/false] --vscode-server [true/false]
Install vscode server (code-server) on interactive session (default: true) Install vscode server (code-server) on interactive session (default: true)
--vscode-version VSCODE_VERSION --vscode-version VSCODE_VERSION
Set vscode server (code-server) version, as well as vscode python extension version <vscode:python-ext> Set vscode server (code-server) version, as well as vscode python extension version <vscode:python-ext> (example: "3.7.4:2020.10.332292344")
(example: "3.7.4:2020.10.332292344")
--vscode-extensions VSCODE_EXTENSIONS --vscode-extensions VSCODE_EXTENSIONS
Install additional vscode extensions, as well as vscode python extension (example: "ms-python.python,ms- Install additional vscode extensions, as well as vscode python extension (example: "ms-python.python,ms-python.black-formatter,ms-python.pylint,ms-python.flake8")
python.black-formatter,ms-python.pylint,ms-python.flake8")
--jupyter-lab [true/false] --jupyter-lab [true/false]
Install Jupyter-Lab on interactive session (default: true) Install Jupyter-Lab on interactive session (default: true)
--upload-files UPLOAD_FILES --upload-files UPLOAD_FILES
Advanced: Upload local files/folders to the remote session. Example: `/my/local/data/` will upload the Advanced: Upload local files/folders to the remote session. Example: `/my/local/data/` will upload the local folder and extract it into the container in ~/session-
local folder and extract it into the container in ~/session-files/ files/
--continue-session CONTINUE_SESSION --continue-session CONTINUE_SESSION
Continue previous session (ID provided) restoring your workspace (see --store-workspace) Continue previous session (ID provided) restoring your workspace (see --store-workspace)
--store-workspace STORE_WORKSPACE --store-workspace STORE_WORKSPACE
Upload/Restore remote workspace folder. Example: `~/workspace/` will automatically restore/store the Upload/Restore remote workspace folder. Example: `~/workspace/` will automatically restore/store the *containers* folder and extract it into next the session. Use
*containers* folder and extract it into next the session. Use with --continue-session to continue your with --continue-session to continue your previous work from your exact container state
previous work from your exact container state
--git-credentials [true/false] --git-credentials [true/false]
If true, local .git-credentials file is sent to the interactive session. (default: false) If true, local .git-credentials file is sent to the interactive session. (default: false)
--user-folder USER_FOLDER --user-folder USER_FOLDER
Advanced: Set the remote base folder (default: ~/) Advanced: Set the remote base folder (default: ~/)
--packages [PACKAGES [PACKAGES ...]] --packages [PACKAGES ...]
Additional packages to add, supports version numbers (default: previously added packages). examples: Additional packages to add, supports version numbers (default: previously added packages). examples: --packages torch==1.7 tqdm
--packages torch==1.7 tqdm
--requirements REQUIREMENTS --requirements REQUIREMENTS
Specify requirements.txt file to install when setting the interactive session. Requirements file is read Specify requirements.txt file to install when setting the interactive session. Requirements file is read and stored in `packages` section as default for the next
and stored in `packages` section as default for the next sessions. Can be overridden by calling sessions. Can be overridden by calling `--packages`
`--packages`
--init-script [INIT_SCRIPT] --init-script [INIT_SCRIPT]
Specify BASH init script file to be executed when setting the interactive session. Script content is Specify BASH init script file to be executed when setting the interactive session. Script content is read and stored as default script for the next sessions. To
read and stored as default script for the next sessions. To clear the init-script do not pass a file clear the init-script do not pass a file
--config-file CONFIG_FILE --config-file CONFIG_FILE
Advanced: Change the configuration file used to store the previous state (default: Advanced: Change the configuration file used to store the previous state (default: ~/.clearml_session.json)
~/.clearml_session.json)
--remote-gateway [REMOTE_GATEWAY] --remote-gateway [REMOTE_GATEWAY]
Advanced: Specify gateway ip/address:port to be passed to interactive session (for use with k8s Advanced: Specify gateway ip/address:port to be passed to interactive session (for use with k8s ingestion / ELB)
ingestion / ELB)
--base-task-id BASE_TASK_ID --base-task-id BASE_TASK_ID
Advanced: Set the base task ID for the interactive session. (default: previously used Task). Use `none` Advanced: Set the base task ID for the interactive session. (default: previously used Task). Use `none` for the default interactive session
for the default interactive session
--project PROJECT Advanced: Set the project name for the interactive session Task --project PROJECT Advanced: Set the project name for the interactive session Task
--session-name SESSION_NAME --session-name SESSION_NAME
Advanced: Set the name of the interactive session Task Advanced: Set the name of the interactive session Task
--session-tags [SESSION_TAGS [SESSION_TAGS ...]] --session-tags [SESSION_TAGS ...]
Advanced: Add tags to the interactive session for increased visibility Advanced: Add tags to the interactive session for increased visibility
--disable-session-cleanup [true/false] --disable-session-cleanup [true/false]
Advanced: If set, previous interactive sessions are not deleted Advanced: If set, previous interactive sessions are not deleted
--keepalive [true/false] --keepalive [true/false]
Advanced: If set, enables the transparent proxy always keeping the sockets alive. Default: False, do not Advanced: If set, enables the transparent proxy always keeping the sockets alive. Default: False, do not use transparent socket for mitigating connection drops.
use transparent socket for mitigating connection drops. --queue-excluded-tag [QUEUE_EXCLUDED_TAG ...]
--queue-excluded-tag [QUEUE_EXCLUDED_TAG [QUEUE_EXCLUDED_TAG ...]]
Advanced: Excluded queues with this specific tag from the selection Advanced: Excluded queues with this specific tag from the selection
--queue-include-tag [QUEUE_INCLUDE_TAG [QUEUE_INCLUDE_TAG ...]] --queue-include-tag [QUEUE_INCLUDE_TAG ...]
Advanced: Only include queues with this specific tag from the selection Advanced: Only include queues with this specific tag from the selection
--skip-docker-network [true/false] --skip-docker-network [true/false]
Advanced: If set, `--network host` is **not** passed to docker (assumes k8s network ingestion) (default: Advanced: If set, `--network host` is **not** passed to docker (assumes k8s network ingestion) (default: false)
false) --password PASSWORD Advanced: Select ssh password for the interactive session (default: `randomly-generated` or previously used one)
--password PASSWORD Advanced: Select ssh password for the interactive session (default: `randomly-generated` or previously --randomize [RANDOMIZE ...]
used one) Advanced: Recreate a new random ssh password for the interactive session options: `--randomize` one time recreate random password, --randomize `always` create a
--randomize [RANDOMIZE [RANDOMIZE ...]] new random password for every session
Advanced: Recreate a new random ssh password for the interactive session options: `--randomize` one time
recreate random password, --randomize `always` create a new random password for every session
--username USERNAME Advanced: Select ssh username for the interactive session (default: `root` or previously used one) --username USERNAME Advanced: Select ssh username for the interactive session (default: `root` or previously used one)
--force-dropbear [true/false] --force-dropbear [true/false]
Force using `dropbear` instead of SSHd Force using `dropbear` instead of SSHd
--disable-storage-packages [true/false]
If True automatic boto3/azure-storage-blob/google-cloud-storage python packages will not be added, you can manually add them using --packages
--disable-store-defaults --disable-store-defaults
If set, do not store current setup as new default configuration If set, do not store current setup as new default configuration
--disable-fingerprint-check --disable-fingerprint-check