Skip to content

Experiment

Experiment

Source code in python/opsml/experiment/_experiment.pyi 
 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
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
class Experiment:
    def start_experiment(
        self,
        space: Optional[str] = None,
        name: Optional[str] = None,
        code_dir: Optional[Path] = None,
        log_hardware: bool = False,
        experiment_uid: Optional[str] = None,
    ) -> "Experiment":
        """
        Start an Experiment

        Args:
            space (str | None):
                space to associate with `ExperimentCard`
            name (str | None):
                Name to associate with `ExperimentCard`
            code_dir (Path | None):
                Directory to log code from
            log_hardware (bool):
                Whether to log hardware information or not
            experiment_uid (str | None):
                Experiment UID. If provided, the experiment will be loaded from the server.

        Returns:
            Experiment
        """

    def __enter__(self) -> "Experiment":
        pass

    def __exit__(self, exc_type, exc_value, traceback) -> None:
        pass

    def log_metric(
        self,
        name: str,
        value: float,
        step: Optional[int] = None,
        timestamp: Optional[int] = None,
        created_at: Optional[datetime] = None,
    ) -> None:
        """
        Log a metric

        Args:
            name (str):
                Name of the metric
            value (float):
                Value of the metric
            step (int | None):
                Step of the metric
            timestamp (int | None):
                Timestamp of the metric
            created_at (datetime | None):
                Created at of the metric
        """

    def log_metrics(self, metrics: list[Metric]) -> None:
        """
        Log multiple metrics

        Args:
            metrics (list[Metric]):
                List of metrics to log
        """

    def log_parameter(
        self,
        name: str,
        value: Union[int, float, str],
    ) -> None:
        """
        Log a parameter

        Args:
            name (str):
                Name of the parameter
            value (int | float | str):
                Value of the parameter
        """

    def log_parameters(self, parameters: list[Parameter]) -> None:
        """
        Log multiple parameters

        Args:
            parameters (list[Parameter]):
                List of parameters to log
        """

    def log_artifact(
        self,
        path: Path,
    ) -> None:
        """
        Log an artifact

        Args:
            path (Path):
                Path to the artifact file. Path must be a file.
                If logging multiple artifacts, use `log_artifacts` instead.
        """

    def log_artifacts(
        self,
        paths: Path,
    ) -> None:
        """
        Log multiple artifacts

        Args:
            paths (Path):
                Paths to a directory containing artifacts.
                All files in the directory will be logged.
        """

    @property
    def card(self) -> "ExperimentCard":
        """
        ExperimentCard associated with the Experiment
        """

    def register_card(
        self,
        card: Union[DataCard, ModelCard, PromptCard],
        version_type: VersionType = VersionType.Minor,
        pre_tag: Optional[str] = None,
        build_tag: Optional[str] = None,
        save_kwargs: Optional[ModelSaveKwargs | DataSaveKwargs] = None,
    ) -> None:
        """Register a Card as part of an experiment

        Args:
            card (DataCard | ModelCard):
                Card to register. Can be a DataCard or a ModelCard
            version_type (VersionType):
                How to increment the version SemVer. Default is VersionType.Minor.
            pre_tag (str):
                Optional pre tag to associate with the version.
            build_tag (str):
                Optional build_tag to associate with the version.
            save_kwargs (SaveKwargs):
                Optional SaveKwargs to pass to the Card interface (If using DataCards
                and ModelCards).

        """

card property

ExperimentCard associated with the Experiment

log_artifact(path)

Log an artifact

Parameters:

Name Type Description Default
path Path

Path to the artifact file. Path must be a file. If logging multiple artifacts, use log_artifacts instead.

 required
Source code in python/opsml/experiment/_experiment.pyi 
103
104
105
106
107
108
109
110
111
112
113
114
def log_artifact(
    self,
    path: Path,
) -> None:
    """
    Log an artifact

    Args:
        path (Path):
            Path to the artifact file. Path must be a file.
            If logging multiple artifacts, use `log_artifacts` instead.
    """

log_artifacts(paths)

Log multiple artifacts

Parameters:

Name Type Description Default
paths Path

Paths to a directory containing artifacts. All files in the directory will be logged.

 required
Source code in python/opsml/experiment/_experiment.pyi 
116
117
118
119
120
121
122
123
124
125
126
127
def log_artifacts(
    self,
    paths: Path,
) -> None:
    """
    Log multiple artifacts

    Args:
        paths (Path):
            Paths to a directory containing artifacts.
            All files in the directory will be logged.
    """

log_metric(name, value, step=None, timestamp=None, created_at=None)

Log a metric

Parameters:

Name Type Description Default
name str

Name of the metric

 required
value float

Value of the metric

 required
step int | None

Step of the metric

 None
timestamp int | None

Timestamp of the metric

 None
created_at datetime | None

Created at of the metric

 None
Source code in python/opsml/experiment/_experiment.pyi 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def log_metric(
    self,
    name: str,
    value: float,
    step: Optional[int] = None,
    timestamp: Optional[int] = None,
    created_at: Optional[datetime] = None,
) -> None:
    """
    Log a metric

    Args:
        name (str):
            Name of the metric
        value (float):
            Value of the metric
        step (int | None):
            Step of the metric
        timestamp (int | None):
            Timestamp of the metric
        created_at (datetime | None):
            Created at of the metric
    """

log_metrics(metrics)

Log multiple metrics

Parameters:

Name Type Description Default
metrics list[Metric]

List of metrics to log

 required
Source code in python/opsml/experiment/_experiment.pyi 
70
71
72
73
74
75
76
77
def log_metrics(self, metrics: list[Metric]) -> None:
    """
    Log multiple metrics

    Args:
        metrics (list[Metric]):
            List of metrics to log
    """

log_parameter(name, value)

Log a parameter

Parameters:

Name Type Description Default
name str

Name of the parameter

 required
value int | float | str

Value of the parameter

 required
Source code in python/opsml/experiment/_experiment.pyi 
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def log_parameter(
    self,
    name: str,
    value: Union[int, float, str],
) -> None:
    """
    Log a parameter

    Args:
        name (str):
            Name of the parameter
        value (int | float | str):
            Value of the parameter
    """

log_parameters(parameters)

Log multiple parameters

Parameters:

Name Type Description Default
parameters list[Parameter]

List of parameters to log

 required
Source code in python/opsml/experiment/_experiment.pyi 
 94
 95
 96
 97
 98
 99
100
101
def log_parameters(self, parameters: list[Parameter]) -> None:
    """
    Log multiple parameters

    Args:
        parameters (list[Parameter]):
            List of parameters to log
    """

register_card(card, version_type=VersionType.Minor, pre_tag=None, build_tag=None, save_kwargs=None)

Register a Card as part of an experiment

Parameters:

Name Type Description Default
card DataCard | ModelCard

Card to register. Can be a DataCard or a ModelCard

 required
version_type VersionType

How to increment the version SemVer. Default is VersionType.Minor.

 Minor
pre_tag str

Optional pre tag to associate with the version.

 None
build_tag str

Optional build_tag to associate with the version.

 None
save_kwargs SaveKwargs

Optional SaveKwargs to pass to the Card interface (If using DataCards and ModelCards).

 None
Source code in python/opsml/experiment/_experiment.pyi 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
def register_card(
    self,
    card: Union[DataCard, ModelCard, PromptCard],
    version_type: VersionType = VersionType.Minor,
    pre_tag: Optional[str] = None,
    build_tag: Optional[str] = None,
    save_kwargs: Optional[ModelSaveKwargs | DataSaveKwargs] = None,
) -> None:
    """Register a Card as part of an experiment

    Args:
        card (DataCard | ModelCard):
            Card to register. Can be a DataCard or a ModelCard
        version_type (VersionType):
            How to increment the version SemVer. Default is VersionType.Minor.
        pre_tag (str):
            Optional pre tag to associate with the version.
        build_tag (str):
            Optional build_tag to associate with the version.
        save_kwargs (SaveKwargs):
            Optional SaveKwargs to pass to the Card interface (If using DataCards
            and ModelCards).

    """

start_experiment(space=None, name=None, code_dir=None, log_hardware=False, experiment_uid=None)

Start an Experiment

Parameters:

Name Type Description Default
space str | None

space to associate with ExperimentCard

 None
name str | None

Name to associate with ExperimentCard

 None
code_dir Path | None

Directory to log code from

 None
log_hardware bool

Whether to log hardware information or not

 False
experiment_uid str | None

Experiment UID. If provided, the experiment will be loaded from the server.

 None

Returns:

Type Description
Experiment

Experiment
Source code in python/opsml/experiment/_experiment.pyi 
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
def start_experiment(
    self,
    space: Optional[str] = None,
    name: Optional[str] = None,
    code_dir: Optional[Path] = None,
    log_hardware: bool = False,
    experiment_uid: Optional[str] = None,
) -> "Experiment":
    """
    Start an Experiment

    Args:
        space (str | None):
            space to associate with `ExperimentCard`
        name (str | None):
            Name to associate with `ExperimentCard`
        code_dir (Path | None):
            Directory to log code from
        log_hardware (bool):
            Whether to log hardware information or not
        experiment_uid (str | None):
            Experiment UID. If provided, the experiment will be loaded from the server.

    Returns:
        Experiment
    """

Metric

Source code in python/opsml/experiment/_experiment.pyi 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
class Metric:
    def __init__(
        self,
        name: str,
        value: float,
        step: Optional[int] = None,
        timestamp: Optional[int] = None,
        created_at: Optional[datetime] = None,
    ) -> None:
        """
        Initialize a Metric

        Args:
            name (str):
                Name of the metric
            value (float):
                Value of the metric
            step (int | None):
                Step of the metric
            timestamp (int | None):
                Timestamp of the metric
            created_at (datetime | None):
                Created at of the metric
        """

    @property
    def name(self) -> str:
        """
        Name of the metric
        """

    @property
    def value(self) -> float:
        """
        Value of the metric
        """

    @property
    def step(self) -> Optional[int]:
        """
        Step of the metric
        """

    @property
    def timestamp(self) -> Optional[int]:
        """
        Timestamp of the metric
        """

    @property
    def created_at(self) -> Optional[datetime]:
        """
        Created at of the metric
        """

created_at property

Created at of the metric

name property

Name of the metric

step property

Step of the metric

timestamp property

Timestamp of the metric

value property

Value of the metric

__init__(name, value, step=None, timestamp=None, created_at=None)

Initialize a Metric

Parameters:

Name Type Description Default
name str

Name of the metric

 required
value float

Value of the metric

 required
step int | None

Step of the metric

 None
timestamp int | None

Timestamp of the metric

 None
created_at datetime | None

Created at of the metric

 None
Source code in python/opsml/experiment/_experiment.pyi 
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
def __init__(
    self,
    name: str,
    value: float,
    step: Optional[int] = None,
    timestamp: Optional[int] = None,
    created_at: Optional[datetime] = None,
) -> None:
    """
    Initialize a Metric

    Args:
        name (str):
            Name of the metric
        value (float):
            Value of the metric
        step (int | None):
            Step of the metric
        timestamp (int | None):
            Timestamp of the metric
        created_at (datetime | None):
            Created at of the metric
    """

Parameter

Source code in python/opsml/experiment/_experiment.pyi 
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
class Parameter:
    def __init__(
        self,
        name: str,
        value: Union[int, float, str],
    ) -> None:
        """
        Initialize a Parameter

        Args:
            name (str):
                Name of the parameter
            value (int | float | str):
                Value of the parameter
        """

    @property
    def name(self) -> str:
        """
        Name of the parameter
        """

    @property
    def value(self) -> Union[int, float, str]:
        """
        Value of the parameter
        """

name property

Name of the parameter

value property

Value of the parameter

__init__(name, value)

Initialize a Parameter

Parameters:

Name Type Description Default
name str

Name of the parameter

 required
value int | float | str

Value of the parameter

 required
Source code in python/opsml/experiment/_experiment.pyi 
254
255
256
257
258
259
260
261
262
263
264
265
266
267
def __init__(
    self,
    name: str,
    value: Union[int, float, str],
) -> None:
    """
    Initialize a Parameter

    Args:
        name (str):
            Name of the parameter
        value (int | float | str):
            Value of the parameter
    """

get_experiment_metrics(experiment_uid, names=None)

Get metrics of an experiment

Parameters:

Name Type Description Default
experiment_uid str

UID of the experiment

 required
names list[str] | None

Names of the metrics to get. If None, all metrics will be returned.

 None

Returns:

Type Description
Metrics

Metrics
Source code in python/opsml/experiment/_experiment.pyi 
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
def get_experiment_metrics(
    experiment_uid: str,
    names: Optional[list[str]] = None,
) -> Metrics:
    """
    Get metrics of an experiment

    Args:
        experiment_uid (str):
            UID of the experiment
        names (list[str] | None):
            Names of the metrics to get. If None, all metrics will be returned.

    Returns:
        Metrics
    """

get_experiment_parameters(experiment_uid, names=None)

Get parameters of an experiment

Parameters:

Name Type Description Default
experiment_uid str

UID of the experiment

 required
names list[str] | None

Names of the parameters to get. If None, all parameters will be returned.

 None

Returns:

Type Description
Parameters

Parameters
Source code in python/opsml/experiment/_experiment.pyi 
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
def get_experiment_parameters(
    experiment_uid: str,
    names: Optional[list[str]] = None,
) -> Parameters:
    """
    Get parameters of an experiment

    Args:
        experiment_uid (str):
            UID of the experiment
        names (list[str] | None):
            Names of the parameters to get. If None, all parameters will be returned.

    Returns:
        Parameters
    """

start_experiment(space=None, name=None, code_dir=None, log_hardware=False, experiment_uid=None)

Start an Experiment

Parameters:

Name Type Description Default
space str | None

space to associate with ExperimentCard

 None
name str | None

Name to associate with ExperimentCard

 None
code_dir Path | None

Directory to log code from

 None
log_hardware bool

Whether to log hardware information or not

 False
experiment_uid str | None

Experiment UID. If provided, the experiment will be loaded from the server.

 None

Returns:

Type Description
Experiment

Experiment
Source code in python/opsml/experiment/_experiment.pyi 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
def start_experiment(
    space: Optional[str] = None,
    name: Optional[str] = None,
    code_dir: Optional[Path] = None,
    log_hardware: bool = False,
    experiment_uid: Optional[str] = None,
) -> Experiment:
    """
    Start an Experiment

    Args:
        space (str | None):
            space to associate with `ExperimentCard`
        name (str | None):
            Name to associate with `ExperimentCard`
        code_dir (Path | None):
            Directory to log code from
        log_hardware (bool):
            Whether to log hardware information or not
        experiment_uid (str | None):
            Experiment UID. If provided, the experiment will be loaded from the server.

    Returns:
        Experiment
    """