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

Terminology update (#1035)

Browse Source
This commit is contained in:
pollfly
2025-02-10 10:17:24 +02:00
committed by GitHub
parent 4667c3d194
commit 085841ab0d
14 changed files with 42 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/apps/clearml_session.md
View File

@@ -41,7 +41,7 @@ error, you are good to go.
clearml-session
```
You can add flags to set a Docker image, the remote SSH port, JupyterLab/VS Code versions, and more. See [CLI options](#command-line-options)
You can add flags to set a container image, the remote SSH port, JupyterLab/VS Code versions, and more. See [CLI options](#command-line-options)
for all configuration options.
`clearml-session` creates a new [Task](../fundamentals/task.md) that is responsible for setting up the SSH and
@@ -57,8 +57,8 @@ error, you are good to go.
launches it.
1. Once the agent finishes the initial setup of the interactive Task, the local `cleaml-session` connects to the host
machine via SSH, and tunnels both SSH and IDE over the SSH connection. If a Docker is specified, the
IDE environment runs inside the Docker.
machine via SSH, and tunnels both SSH and IDE over the SSH connection. If a container is specified, the
IDE environment runs inside of it.
1. The CLI outputs access links to the remote JupyterLab and VS Code sessions:
@@ -106,8 +106,8 @@ To connect to an existing session:
1. Click on the JupyterLab / VS Code link that is outputted, or connect directly to the SSH session
## Features
### Running in Docker
To run a session inside a Docker container, use the `--docker` flag and enter the docker image to use in the interactive
### Running in a Container
To run a session inside a container, use the `--docker` flag and enter the image to use in the interactive
session.
### Kubernetes Support
@@ -224,8 +224,8 @@ clearml-session --continue-session <session_id> --store-workspace ~/workspace
| `--disable-fingerprint-check` | If set, bypass the remote SSH server fingerprint verification process | `none` |
| `--disable-session-cleanup` | If `True`, previous interactive sessions are not deleted | `false`|
| `--disable-store-defaults` | If set, do not store current setup as new default configuration| `none`|
| `--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 |
| `--docker`| Select the image to use in the interactive session |`nvidia/cuda:11.6.2-runtime-ubuntu20.04` or previously used 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`|
| `--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 |

12
docs/apps/clearml_task.md
View File

@@ -18,7 +18,7 @@ line arguments, Python module dependencies, and a requirements.txt file!
## How Does ClearML Task Work?
1. Execute `clearml-task`, specifying the ClearML target project and task name, along with your script (and repository / commit / branch).
Optionally, specify an execution queue and Docker image to use.
Optionally, specify an execution queue and container image to use.
1. `clearml-task` does its magic! It creates a new [ClearML Task](../fundamentals/task.md),
and, if so directed, enqueues it for execution by a ClearML Agent.
1. While the Task is running on the remote machine, all its console outputs are logged in real-time, alongside your
@@ -26,9 +26,9 @@ line arguments, Python module dependencies, and a requirements.txt file!
(a link to your task details page in the ClearML Web UI is printed as ClearML Task creates the task).
## Execution Configuration
### Docker
Specify a Docker container to run the code in with the `--docker <docker_image>` option.
The ClearML Agent pulls it from Docker Hub or a Docker artifactory automatically.
### Container
Specify a container to run the code in with the `--docker <image>` option.
The ClearML Agent pulls it from Docker Hub or a container artifactory automatically.
### Package Dependencies
`clearml-task` automatically finds the `requirements.txt` file in remote repositories.
@@ -61,8 +61,8 @@ errors in identifying the correct default branch.
| `--branch` | Select repository branch / tag. By default, latest commit from the master branch | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `--commit` | Select commit ID to use. By default, latest commit, or local commit ID when using local repository | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `--cwd` | Working directory to launch the script from. Relative to repo root or local `--folder` | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `--docker` | Select the Docker image to use in the remote task | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `--docker_bash_setup_script` | Add a bash script to be executed inside the Docker before setting up the task's environment | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `--docker` | Select the container image to use in the remote task | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `--docker_bash_setup_script` | Add a bash script to be executed inside the container before setting up the task's environment | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `--docker_args` | Add Docker arguments. Pass a single string in the following format: `--docker_args "<argument_string>"`. For example: `--docker_args "-v some_dir_1:other_dir_1 -v some_dir_2:other_dir_2"` | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `--folder` | Execute the code from a local folder. Notice, it assumes a git repository already exists. Current state of the repo (commit ID and uncommitted changes) is logged and replicated on the remote machine | <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |
| `--import-offline-session`| Specify the path to the offline session you want to import.| <img src="/docs/latest/icons/ico-optional-no.svg" alt="No" className="icon size-md center-md" /> |