ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-01-30 22:18:02 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add pipeline clone (#996)

Browse Source
This commit is contained in:
pollfly 2025-01-07 10:18:54 +02:00 committed by GitHub
parent d038923abc
commit cd442c989f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/pipelines/pipelines.md
View File

@ -85,11 +85,24 @@ the execution of every task in a pipeline. Additionally, you can create customiz
When you run your pipeline, ClearML collects and stores all the information required to reproduce the run (DAG,
configuration, installed packages, uncommitted changes etc.).
You can rerun the pipeline via the [ClearML Web UI](../webapp/pipelines/webapp_pipeline_table.md). To launch a new run
for a pipeline, click **+ NEW RUN** on the top left of the pipeline runs page. This opens a **NEW RUN** modal, where you
You can rerun the pipeline programmatically or via the ClearML Web UI:
* To programmatically create a new run, use [`PipelineController.clone()`](../references/sdk/automation_controller_pipelinecontroller.md#pipelinecontrollerclone)
which returns a copy of the original pipeline in [*draft*](../fundamentals/task.md#task-states) state, allowing you to
modify any configuration. Run the new pipeline using [`PipelineController.start()`](../references/sdk/automation_controller_pipelinecontroller.md#start).
```python
pipeline = PipelineController.get(pipeline_id="<pipeline_ID>")
cloned_pipeline = PipelineController.clone(pipeline_controller=pipeline)
# tweak pipeline parameters
cloned_pipeline.start()
```
* To launch a new pipeline run in the UI, click **+ NEW RUN** in the [pipeline runs](../webapp/pipelines/webapp_pipeline_table.md) page. This opens a **NEW RUN** modal, where you
can set the run's parameters and execution queue.
![Pipeline params UI](../img/pipelines_new_run.png)
![Pipeline params UI](../img/pipelines_new_run.png)
The new pipeline run will be executed through the execution queue by a ClearML agent. The agent will rebuild
the pipeline according to the configuration and DAG that was captured in the original run, and override the original