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

Update pipeline version info ()

Browse Source
This commit is contained in:
pollfly 2023-10-18 10:22:18 +03:00 committed by GitHub
parent 47a5a23253
commit 328d3729ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 8 deletions

7
docs/pipelines/pipelines.md
View File

@ -105,10 +105,9 @@ when rerun, the pipeline DAG will be generated from the pipeline configuration s
lets you modify the pipeline configuration via the UI, without changing the original codebase. lets you modify the pipeline configuration via the UI, without changing the original codebase.
### Pipeline Versions ### Pipeline Versions
Each pipeline must be assigned a version number to help track the evolution of your pipeline structure and parameters. You can assign each pipeline a version number to help track the evolution of your pipeline structure and parameters.
The pipeline's version automatically bumps up if there is a change in the pipeline code. If there is no change, the
If you pass `auto_version_bump=True` when instantiating a PipelineController, the pipeline's version automatically bumps up pipeline retains its version number.
if there is a change in the pipeline code. If there is no change, the pipeline retains its version number.
### Tracking Pipeline Progress ### Tracking Pipeline Progress
ClearML automatically tracks a pipeline's progress percentage: the number of pipeline steps completed out of the total ClearML automatically tracks a pipeline's progress percentage: the number of pipeline steps completed out of the total

4
docs/pipelines/pipelines_sdk_function_decorators.md
View File

@ -39,8 +39,8 @@ def main(pickle_url, mock_parameter='mock'):
* `name` - The name for the pipeline controller task * `name` - The name for the pipeline controller task
* `project` - The ClearML project where the pipeline controller task is stored * `project` - The ClearML project where the pipeline controller task is stored
* `version` - Numbered version string (e.g. 1.2.3). If `auto_version_bump` is set to `True`, the version number is * `version` - Numbered version string (e.g. `1.2.3`). If not set, find the pipeline's latest version and increment
automatically bumped if the same version already exists and the pipeline code has changed 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). * `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 * `args_map` - Map arguments to their [configuration section](../fundamentals/hyperparameters.md#webapp-interface) in
the following format: `{'section_name':['param_name']]}`. For example, the pipeline in the code above will store the the following format: `{'section_name':['param_name']]}`. For example, the pipeline in the code above will store the

4
docs/pipelines/pipelines_sdk_tasks.md
View File

@ -15,8 +15,8 @@ pipe = PipelineController(
* `name` - The name for the pipeline controller task * `name` - The name for the pipeline controller task
* `project` - The ClearML project where the pipeline tasks will be created. * `project` - The ClearML project where the pipeline tasks will be created.
* `version` - Numbered version string (`e.g. 1.2.3`). When `auto_version_bump` is set to `True`, the version number will * `version` - Numbered version string (e.g. `1.2.3`). If not set, find the pipeline's latest version and increment
be automatically bumped if the same version already exists and the code has changed it. If no such version is found, defaults to `1.0.0`
See [PipelineController](../references/sdk/automation_controller_pipelinecontroller.md) for all arguments. See [PipelineController](../references/sdk/automation_controller_pipelinecontroller.md) for all arguments.