Add Docker mode notes (#890)

This commit is contained in:
pollfly
2024-08-04 18:50:09 +03:00
committed by GitHub
parent 9371e861f4
commit 5353bd3cf6
4 changed files with 40 additions and 8 deletions

View File

@@ -72,6 +72,17 @@ To create an experiment through the UI interface:
* Image - Docker image to use for running the experiment
* Arguments - Add Docker arguments as a single string
* Startup Script - Add a bash script to be executed inside the Docker before setting up the experiment's environment
:::important
For a task to run in the specified container, the ClearML Agent executing the task must be running in
Docker mode:
```bash
clearml-agent daemon --queue <execution_queue_to_pull_from> --docker
```
For more information, see [Docker Mode](../clearml_agent/clearml_agent_execution_env.md#docker-mode).
:::
* **Run**
* Queue - [ClearML Queue](../fundamentals/agents_and_queues.md#what-is-a-queue) where the experiment should be
enqueued for execution

View File

@@ -92,6 +92,16 @@ The Container section list the following information:
* Arguments - add Docker arguments
* Setup shell script - a bash script to be executed inside the Docker before setting up the experiment's environment
:::important
To [rerun](webapp_exp_tuning.md) an experiment through the UI in the listed container, the ClearML Agent executing the experiment must be running in
Docker mode:
```bash
clearml-agent daemon --queue <execution_queue_to_pull_from> --docker [optional default docker image to use]
```
For more information, see [Docker Mode](../clearml_agent/clearml_agent_execution_env.md#docker-mode).
:::
![Container section](../img/webapp_exp_container.png)

View File

@@ -77,7 +77,16 @@ Select a pre-configured Docker that **ClearML Agent** will use to remotely execu
* In **EXECUTION** **>** **AGENT CONFIGURATION** **>** **BASE DOCKER IMAGE** **>** hover **>** **EDIT** **>**
Enter the base Docker image.
:::important
For a ClearML Agent to execute the task in a container, the agent must be running in
Docker mode:
```bash
clearml-agent daemon --queue <execution_queue_to_pull_from> --docker [optional default docker image to use]
```
For more information, see [Docker Mode](../clearml_agent/clearml_agent_execution_env.md#docker-mode).
:::
#### Output Destination