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

Small edits (#768)

Browse Source
This commit is contained in:
pollfly 2024-01-29 13:31:14 +02:00 committed by GitHub
parent 0cc6baf7d3
commit f017ca99b3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/guides/pipeline/pipeline_controller.md
View File

@ -30,7 +30,7 @@ The sections below describe in more detail what happens in the controller task a
## The Pipeline Controller
1. Create the [PipelineController](../../references/sdk/automation_controller_pipelinecontroller.md) object:
1. Create the [`PipelineController`](../../references/sdk/automation_controller_pipelinecontroller.md) object:
```python
pipe = PipelineController(

2
docs/pipelines/pipelines_sdk_function_decorators.md
View File

@ -4,7 +4,7 @@ title: PipelineDecorator
## Creating Pipelines Using Function Decorators
Use the [PipelineDecorator](../references/sdk/automation_controller_pipelinecontroller.md#class-automationcontrollerpipelinedecorator)
Use the [`PipelineDecorator`](../references/sdk/automation_controller_pipelinecontroller.md#class-automationcontrollerpipelinedecorator)
class to create pipelines from your existing functions. Use [`@PipelineDecorator.component`](../references/sdk/automation_controller_pipelinecontroller.md#pipelinedecoratorcomponent)
to denote functions that comprise the steps of your pipeline, and [`@PipelineDecorator.pipeline`](../references/sdk/automation_controller_pipelinecontroller.md#pipelinedecoratorpipeline)
for your main pipeline execution logic function.

11
docs/pipelines/pipelines_sdk_tasks.md
View File

@ -4,7 +4,7 @@ title: PipelineController
## The PipelineController Class
Create the [PipelineController](../references/sdk/automation_controller_pipelinecontroller.md), where you will define
Create the [`PipelineController`](../references/sdk/automation_controller_pipelinecontroller.md), where you will define
the pipeline's execution logic:
```python
from clearml import PipelineController
@ -45,9 +45,9 @@ values for the new run.
![Pipeline new run](../img/pipelines_new_run.png)
### Additional Configuration
You can connect configuration dictionaries or files to a pipeline controller using the
[PipelineController.connect_configuration](../references/sdk/automation_controller_pipelinecontroller.md#connect_configuration)
method by providing the configuration object, or file path.
You can connect configuration dictionaries or files to a pipeline controller using
[`PipelineController.connect_configuration()`](../references/sdk/automation_controller_pipelinecontroller.md#connect_configuration)
by providing the configuration object, or file path.
For files, call `connect_configuration()` before reading the configuration file. If it's a local file, input a relative
path.
@ -55,7 +55,8 @@ path.
```python
config_file = pipe.connect_configuration(
configuration=config_file_path,
name="My Configuration", description="configuration for pipeline"
name="My Configuration",
description="configuration for pipeline"
)
my_params = json.load(open(config_file,'rt'))
```