From f017ca99b37350fd3aee059eb1028e375ad6aeca Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Mon, 29 Jan 2024 13:31:14 +0200 Subject: [PATCH] Small edits (#768) --- docs/guides/pipeline/pipeline_controller.md | 2 +- docs/pipelines/pipelines_sdk_function_decorators.md | 2 +- docs/pipelines/pipelines_sdk_tasks.md | 11 ++++++----- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/guides/pipeline/pipeline_controller.md b/docs/guides/pipeline/pipeline_controller.md index a06e9a9e..4b575432 100644 --- a/docs/guides/pipeline/pipeline_controller.md +++ b/docs/guides/pipeline/pipeline_controller.md @@ -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( diff --git a/docs/pipelines/pipelines_sdk_function_decorators.md b/docs/pipelines/pipelines_sdk_function_decorators.md index 478a318f..eebe1f47 100644 --- a/docs/pipelines/pipelines_sdk_function_decorators.md +++ b/docs/pipelines/pipelines_sdk_function_decorators.md @@ -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. diff --git a/docs/pipelines/pipelines_sdk_tasks.md b/docs/pipelines/pipelines_sdk_tasks.md index e61ff1ac..2760b6d5 100644 --- a/docs/pipelines/pipelines_sdk_tasks.md +++ b/docs/pipelines/pipelines_sdk_tasks.md @@ -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')) ```