KedroAzureMLConfig

kedro_azureml_pipeline.config.KedroAzureMLConfig

Bases: BaseModel

Top-level plugin configuration loaded from azureml.yml.

Parameters

Name	Type	Description	Default
workspace	WorkspacesConfig	Named Azure ML workspace definitions.	required
compute	ComputeConfig	Named compute cluster definitions.	required
execution	ExecutionConfig	Code packaging and execution settings.	required
schedules	dict of str to ScheduleConfig	Reusable named schedule definitions.	required
jobs	dict of str to JobConfig	Named job definitions.	required

Examples

# conf/base/azureml.yml
workspace:
  __default__:
    subscription_id: "abc-123"
    resource_group: "my-rg"
    name: "my-workspace"

compute:
  __default__:
    cluster_name: "cpu-cluster"

execution:
  environment: "my-env@latest"

jobs:
  __default__:
    pipeline:
      pipeline_name: __default__

See Also

WorkspacesConfig : Workspace definitions. ComputeConfig : Compute cluster definitions. JobConfig : Individual job configurations. KedroContextManager : Loads and validates this config.

Source Code

View on GitHub

Show/Hide source

class KedroAzureMLConfig(BaseModel):
    """Top-level plugin configuration loaded from ``azureml.yml``.

    Parameters
    ----------
    workspace : WorkspacesConfig
        Named Azure ML workspace definitions.
    compute : ComputeConfig
        Named compute cluster definitions.
    execution : ExecutionConfig
        Code packaging and execution settings.
    schedules : dict of str to ScheduleConfig
        Reusable named schedule definitions.
    jobs : dict of str to JobConfig
        Named job definitions.

    Examples
    --------
    ```yaml
    # conf/base/azureml.yml
    workspace:
      __default__:
        subscription_id: "abc-123"
        resource_group: "my-rg"
        name: "my-workspace"

    compute:
      __default__:
        cluster_name: "cpu-cluster"

    execution:
      environment: "my-env@latest"

    jobs:
      __default__:
        pipeline:
          pipeline_name: __default__
    ```

    See Also
    --------
    [WorkspacesConfig][kedro_azureml_pipeline.config.WorkspacesConfig] : Workspace definitions.
    [ComputeConfig][kedro_azureml_pipeline.config.ComputeConfig] : Compute cluster definitions.
    [JobConfig][kedro_azureml_pipeline.config.JobConfig] : Individual job configurations.
    [KedroContextManager][kedro_azureml_pipeline.manager.KedroContextManager] : Loads and validates this config.
    """

    model_config = ConfigDict(extra="forbid")

    workspace: WorkspacesConfig = Field(description="Named Azure ML workspace definitions.")
    compute: ComputeConfig = Field(description="Named compute cluster definitions.")
    execution: ExecutionConfig = Field(
        default_factory=ExecutionConfig, description="Code packaging and execution settings."
    )
    schedules: dict[str, ScheduleConfig] = Field(
        default_factory=dict, description="Reusable named schedule definitions."
    )
    jobs: dict[str, JobConfig] = Field(default_factory=dict, description="Named job definitions.")