ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#796)

Browse Source
This commit is contained in:
pollfly
2024-03-12 11:24:42 +02:00
committed by GitHub
parent dce8b12932
commit 67cfbb1ef6
28 changed files with 58 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/pipelines/pipelines_sdk_function_decorators.md
View File

@@ -38,7 +38,7 @@ def main(pickle_url, mock_parameter='mock'):
* `name` - The name for the pipeline controller task
* `project` - The ClearML project where the pipeline controller task is stored
* `version` - Numbered version string (e.g. `1.2.3`). If not set, find the pipeline's latest version and increment
* `version` - Numbered version string (for example, `1.2.3`). If not set, find the pipeline's latest version and increment
it. If no such version is found, defaults to `1.0.0`
* `default_queue` - The default [ClearML Queue](../fundamentals/agents_and_queues.md#what-is-a-queue) in which to enqueue all pipeline steps (unless otherwise specified in the pipeline step).
* `args_map` - Map arguments to their [configuration section](../fundamentals/hyperparameters.md#webapp-interface) in

6
docs/pipelines/pipelines_sdk_tasks.md
View File

@@ -16,7 +16,7 @@ pipe = PipelineController(
* `name` - The name for the pipeline controller task
* `project` - The ClearML project where the pipeline tasks will be created.
* `version` - Numbered version string (e.g. `1.2.3`). If not set, find the pipeline's latest version and increment
* `version` - Numbered version string (for example, `1.2.3`). If not set, find the pipeline's latest version and increment
it. If no such version is found, defaults to `1.0.0`
See [PipelineController](../references/sdk/automation_controller_pipelinecontroller.md) for all arguments.
@@ -109,7 +109,7 @@ See [`PipelineController.add_step`](../references/sdk/automation_controller_pipe
#### parameter_override
Use the `parameter_override` argument to modify the step's parameter values. The `parameter_override` dictionary key is
the task parameter's full path, which includes the parameter section's name and the parameter name separated by a slash
(e.g. `'General/dataset_url'`). Passing `"${}"` in the argument value lets you reference input/output configurations
(for example, `'General/dataset_url'`). Passing `"${}"` in the argument value lets you reference input/output configurations
from other pipeline steps. For example: `"${<step_name>.id}"` will be converted to the Task ID of the referenced pipeline
step.
@@ -189,7 +189,7 @@ ClearmlJob.
If the callback returned value is False, the step is skipped and so is any step in the pipeline that relies on this step.
Notice the parameters are already parsed (e.g. `${step1.parameters.Args/param}` is replaced with relevant value).
Notice the parameters are already parsed (for example, `${step1.parameters.Args/param}` is replaced with relevant value).
```python
def step_created_callback(