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

Add note to pipeline example (#242)

Browse Source
This commit is contained in:
pollfly 2022-05-01 10:12:15 +03:00 committed by GitHub
parent 4660fb8ea0
commit 16e458864d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/guides/pipeline/pipeline_decorator.md
View File

@ -35,6 +35,11 @@ In the example script, the controller defines the interactions between the pipel
1. The second step's output, `preprocessed_data`, is modified within the pipeline execution logic 1. The second step's output, `preprocessed_data`, is modified within the pipeline execution logic
1. The modified data is passed to the third step, `step_three`. 1. The modified data is passed to the third step, `step_three`.
:::info Local Execution
In this example, the pipeline is set to run in local mode by using the [PipelineDecorator.run_locally](../../references/sdk/automation_controller_pipelinecontroller.md#pipelinedecoratorrun_locally)
method before calling the pipeline function. See pipeline execution options [here](../../pipelines/pipelines_sdk_function_decorators.md#running-the-pipeline).
:::
## Pipeline Steps ## Pipeline Steps
Using the `@PipelineDecorator.component` decorator will make the function a pipeline component that can be called from the Using the `@PipelineDecorator.component` decorator will make the function a pipeline component that can be called from the
pipeline controller, which implements the pipeline's execution logic. For detailed information, see [`@PipelineDecorator.component`](../../references/sdk/automation_controller_pipelinecontroller.md#pipelinedecoratorcomponent). pipeline controller, which implements the pipeline's execution logic. For detailed information, see [`@PipelineDecorator.component`](../../references/sdk/automation_controller_pipelinecontroller.md#pipelinedecoratorcomponent).