aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/azure/ai/ml/entities/_deployment/run_settings.py
blob: f1deac83996a29344bba0f73327c1b5d5ff5e156 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# ---------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# ---------------------------------------------------------

from typing import Any, Dict, Optional

from azure.ai.ml._schema._deployment.batch.run_settings_schema import RunSettingsSchema
from azure.ai.ml._utils._experimental import experimental
from azure.ai.ml.constants._common import BASE_PATH_CONTEXT_KEY


@experimental
class RunSettings:
    """Run Settings entity.

    :param name: Run settings name
    :type name: str
    :param display_name: Run settings display name
    :type display_name: str
    :param experiment_name: Run settings experiment name
    :type experiment_name: str
    :param description: Run settings description
    :type description: str
    :param tags: Run settings tags
    :type tags: Dict[str, Any]
    :param settings: Run settings - settings
    :type settings: Dict[str, Any]
    """

    def __init__(
        self,
        name: Optional[str] = None,
        display_name: Optional[str] = None,
        experiment_name: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[Dict[str, Any]] = None,
        settings: Optional[Dict[str, Any]] = None,
        **kwargs: Any,
    ):  # pylint: disable=unused-argument
        self.name = name
        self.display_name = display_name
        self.experiment_name = experiment_name
        self.description = description
        self.tags = tags
        self.settings = settings

    def _to_dict(self) -> Dict:
        # pylint: disable=no-member
        res: dict = RunSettingsSchema(context={BASE_PATH_CONTEXT_KEY: "./"}).dump(self)
        return res