JobConfig

kedro_azureml_pipeline.config.JobConfig

Bases: BaseModel

A single named job configuration.

Parameters

Name	Type	Description	Default
pipeline	PipelineFilterOptions	Pipeline selection and filter options.	required
workspace	str or None	Named workspace to use (falls back to __default__).	required
experiment_name	str or None	Azure ML experiment name.	required
display_name	str or None	Display name shown in the Azure ML portal.	required
compute	str or None	Named compute entry to use.	required
schedule	ScheduleConfig or str or None	Inline schedule, named schedule reference, or None for ad-hoc.	required
params	dict of str to Any or None	Job-level runtime parameters merged into every step. CLI --params take precedence.	required
retry	RetryConfig or None	Retry settings applied to every step in this job.	required
description	str or None	Human-readable job description.	required

Examples

jobs:
  __default__:
    pipeline:
      pipeline_name: __default__
    experiment_name: "my-experiment"
  nightly:
    pipeline:
      pipeline_name: data_processing
    schedule:
      cron:
        expression: "0 2 * * *"
    retry:
      max_retries: 3
      timeout: 3600

See Also

PipelineFilterOptions : Pipeline node filtering. ScheduleConfig : Schedule trigger specification. RetryConfig : Retry settings.

Source Code

View on GitHub

Show/Hide source

class JobConfig(BaseModel):
    """A single named job configuration.

    Parameters
    ----------
    pipeline : PipelineFilterOptions
        Pipeline selection and filter options.
    workspace : str or None
        Named workspace to use (falls back to ``__default__``).
    experiment_name : str or None
        Azure ML experiment name.
    display_name : str or None
        Display name shown in the Azure ML portal.
    compute : str or None
        Named compute entry to use.
    schedule : ScheduleConfig or str or None
        Inline schedule, named schedule reference, or ``None`` for ad-hoc.
    params : dict of str to Any or None
        Job-level runtime parameters merged into every step. CLI --params take precedence.
    retry : RetryConfig or None
        Retry settings applied to every step in this job.
    description : str or None
        Human-readable job description.

    Examples
    --------
    ```yaml
    jobs:
      __default__:
        pipeline:
          pipeline_name: __default__
        experiment_name: "my-experiment"
      nightly:
        pipeline:
          pipeline_name: data_processing
        schedule:
          cron:
            expression: "0 2 * * *"
        retry:
          max_retries: 3
          timeout: 3600
    ```

    See Also
    --------
    [PipelineFilterOptions][kedro_azureml_pipeline.config.PipelineFilterOptions] : Pipeline node filtering.
    [ScheduleConfig][kedro_azureml_pipeline.config.ScheduleConfig] : Schedule trigger specification.
    [RetryConfig][kedro_azureml_pipeline.config.RetryConfig] : Retry settings.
    """

    model_config = ConfigDict(extra="forbid")

    pipeline: PipelineFilterOptions = Field(description="Pipeline selection and filter options.")
    workspace: str | None = Field(default=None, description="Named workspace to use (falls back to '__default__').")
    experiment_name: str | None = Field(default=None, description="Azure ML experiment name.")
    display_name: str | None = Field(default=None, description="Display name shown in the Azure ML portal.")
    compute: str | None = Field(default=None, description="Named compute entry to use.")
    schedule: ScheduleConfig | str | None = Field(
        default=None, description="Inline schedule, named schedule reference, or None for ad-hoc."
    )
    params: dict[str, Any] | None = Field(
        default=None,
        description="Job-level runtime parameters merged into every step. CLI --params take precedence.",
    )
    retry: RetryConfig | None = Field(default=None, description="Retry settings applied to every step in this job.")
    description: str | None = Field(default=None, description="Human-readable job description.")