ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-25 15:09:34 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'main' of https://github.com/allegroai/clearml-docs

Browse Source
This commit is contained in:
revital 2024-12-24 10:17:45 +02:00
commit f1fbc1e456
13 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/clearml_agent/clearml_agent_deployment.md
View File

@ -145,7 +145,7 @@ Slurm Glue is available under the ClearML Enterprise plan.
::: :::
Agents can be deployed bare-metal or inside [`Singularity`](https://docs.sylabs.io/guides/3.5/user-guide/introduction.html) Agents can be deployed bare-metal or inside [`Singularity`](https://docs.sylabs.io/guides/3.5/user-guide/introduction.html)
containers in linux clusters managed with Slurm. containers in Linux clusters managed with Slurm.
ClearML Agent Slurm Glue maps jobs to Slurm batch scripts: associate a ClearML queue to a batch script template, then ClearML Agent Slurm Glue maps jobs to Slurm batch scripts: associate a ClearML queue to a batch script template, then
when a Task is pushed into the queue, it will be converted and executed as an `sbatch` job according to the sbatch when a Task is pushed into the queue, it will be converted and executed as an `sbatch` job according to the sbatch

2
docs/clearml_agent/clearml_agent_env_var.md
View File

@ -27,7 +27,7 @@ but can be overridden by command-line arguments.
|**CLEARML_AGENT_DISABLE_SSH_MOUNT** | Disables the auto `.ssh` mount into the docker | |**CLEARML_AGENT_DISABLE_SSH_MOUNT** | Disables the auto `.ssh` mount into the docker |
|**CLEARML_AGENT_FORCE_CODE_DIR**| Allows overriding the remote execution code directory to bypass repository cloning and use a repo already available where the remote agent is running. | |**CLEARML_AGENT_FORCE_CODE_DIR**| Allows overriding the remote execution code directory to bypass repository cloning and use a repo already available where the remote agent is running. |
|**CLEARML_AGENT_FORCE_EXEC_SCRIPT**| Allows overriding the remote execution script to bypass repository cloning and execute code already available where the remote agent is running. Use `module:file.py` format to specify a module and a script to execute (e.g. `.:main.py` to run `main.py` from the working dir)| |**CLEARML_AGENT_FORCE_EXEC_SCRIPT**| Allows overriding the remote execution script to bypass repository cloning and execute code already available where the remote agent is running. Use `module:file.py` format to specify a module and a script to execute (e.g. `.:main.py` to run `main.py` from the working dir)|
|**CLEARML_AGENT_FORCE_TASK_INIT**| If set to `1`, ClearML Agent adds `Task.init()` to scripts that do not have the call, creating a Task to capture code execution information and output, which is then sent to the ClearML Server. If set to `0` and the script does not include `Task.init()`, the agent will capture only the output streams and console output, without tracking code execution details, metrics, or models. | |**CLEARML_AGENT_FORCE_TASK_INIT**| If set to `1`, ClearML Agent adds `Task.init()` to scripts that do not have the call, creating a Task to capture code execution information and output, which is then sent to the ClearML Server. If set to `0` and the script does not include `Task.init()`, the agent will capture only the output streams and console output, without tracking code execution details, metrics, or models. |
|**CLEARML_AGENT_FORCE_SYSTEM_SITE_PACKAGES** | If set to `1`, overrides default [`agent.package_manager.system_site_packages: true`](../configs/clearml_conf.md#system_site_packages) behavior when running tasks in containers (docker mode and k8s-glue)| |**CLEARML_AGENT_FORCE_SYSTEM_SITE_PACKAGES** | If set to `1`, overrides default [`agent.package_manager.system_site_packages: true`](../configs/clearml_conf.md#system_site_packages) behavior when running tasks in containers (docker mode and k8s-glue)|
|**CLEARML_AGENT_GIT_CLONE_VERBOSE**| If set to `1`, `git clone` calls will report progress verbosely | |**CLEARML_AGENT_GIT_CLONE_VERBOSE**| If set to `1`, `git clone` calls will report progress verbosely |
|**CLEARML_AGENT_GIT_USER** | Sets the Git user for ClearML Agent | |**CLEARML_AGENT_GIT_USER** | Sets the Git user for ClearML Agent |

3
docs/clearml_agent/clearml_agent_execution_env.md
View File

@ -28,8 +28,9 @@ If you are using pyenv to control the environment where you use ClearML Agent, y
## Docker Mode ## Docker Mode
:::note notes :::note notes
* Docker Mode is only supported in linux. * Docker Mode is only supported in Linux.
* Docker Mode requires docker service v19.03 or higher installed. * Docker Mode requires docker service v19.03 or higher installed.
* If your machine requires root permissions to run Docker, the ClearML Agent in Docker Mode must also run with root permissions.
::: :::
When executing the ClearML Agent in Docker mode, it will: When executing the ClearML Agent in Docker mode, it will:

2
docs/release_notes/clearml_server/enterprise/ver_3_20.md
View File

@ -28,7 +28,7 @@ title: Version 3.20
**Bug Fixes** **Bug Fixes**
* Fix UI experiment plot comparison displays duplicates of image plots * Fix UI experiment plot comparison displays duplicates of image plots
* Fix downloading UI experiment console log sometimes returns an older file * Fix downloading UI experiment console log sometimes returns an older file
### Enterprise Server 3.20.0 ### Enterprise Server 3.20.0

2
docs/webapp/applications/apps_aws_autoscaler.md
View File

@ -32,7 +32,7 @@ when viewing its configuration.
The prefilled instance launch form can be edited before starting the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
to open the app's instance launch form. to open the app's instance launch form.
### Configuration Options ### Configuration Options

2
docs/webapp/applications/apps_gcp_autoscaler.md
View File

@ -32,7 +32,7 @@ when viewing its configuration.
The prefilled instance launch form can be edited before starting the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
to open the app's instance launch form. to open the app's instance launch form.
### Configuration Options ### Configuration Options

2
docs/webapp/applications/apps_gradio.md
View File

@ -51,7 +51,7 @@ when viewing its configuration.
The prefilled instance launch form can be edited before starting the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
to open the app's instance launch form. to open the app's instance launch form.
### Configuration Options ### Configuration Options

2
docs/webapp/applications/apps_jupyter_lab.md
View File

@ -39,7 +39,7 @@ when viewing its configuration.
The prefilled instance launch form can be edited before starting the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
to open the app's instance launch form. to open the app's instance launch form.
### Configuration Options ### Configuration Options

2
docs/webapp/applications/apps_ssh_session.md
View File

@ -56,7 +56,7 @@ when viewing its configuration.
The prefilled instance launch form can be edited before starting the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
to open the app's instance launch form. to open the app's instance launch form.

2
docs/webapp/applications/apps_streamlit.md
View File

@ -51,7 +51,7 @@ when viewing its configuration.
The prefilled instance launch form can be edited before starting the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
to open the app's instance launch form. to open the app's instance launch form.
### Configuration Options ### Configuration Options

2
docs/webapp/applications/apps_vscode.md
View File

@ -39,7 +39,7 @@ when viewing its configuration.
The prefilled instance launch form can be edited before starting the new app instance. The prefilled instance launch form can be edited before starting the new app instance.
To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" /> To configure a new app instance, click `Launch New` <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />
to open the app's instance launch form. to open the app's instance launch form.
### Configuration Options ### Configuration Options

2
docs/webapp/pipelines/webapp_pipeline_table.md
View File

@ -12,7 +12,7 @@ or comparison view <img src="/docs/latest/icons/ico-charts-view.svg" alt="Compar
using the buttons on the top left of the page. Use the details view to access a selected run's details, while keeping using the buttons on the top left of the page. Use the details view to access a selected run's details, while keeping
the run list in view. Details view can also be accessed by double-clicking a specific pipeline run in the table view to the run list in view. Details view can also be accessed by double-clicking a specific pipeline run in the table view to
open its details view. Use the [comparison view](#comparing-runs) to compare your pipeline run's scalar and plot results. open its details view. Use the [comparison view](#comparing-runs) to compare your pipeline run's scalar and plot results.
This view compares the scalars/plots of currently selected pipeline runs. If no runs are selected, The first 100 visible This view compares the scalars/plots of currently selected pipeline runs. If no runs are selected, The first 100 visible
runs in the table are compared. runs in the table are compared.
You can archive pipeline runs so the runs table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the You can archive pipeline runs so the runs table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the

2
docs/webapp/webapp_exp_track_visual.md
View File

@ -221,7 +221,7 @@ The **INFO** tab shows extended experiment information:
This feature is available under the ClearML Enterprise plan. This feature is available under the ClearML Enterprise plan.
::: :::
The Enterprise Server also displays a detailed history of task activity: The Enterprise Server also displays a detailed history of task activity:
* Task action (e.g. status changes, project move, etc.) * Task action (e.g. status changes, project move, etc.)
* Action time * Action time
* Acting user * Acting user