Skip to content

Types

CommonKwargs

Source code in python/opsml/types/_types.pyi 
 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
51
class CommonKwargs:
    IsPipeline: "CommonKwargs"
    ModelType: "CommonKwargs"
    ModelClass: "CommonKwargs"
    ModelArch: "CommonKwargs"
    PreprocessorName: "CommonKwargs"
    Preprocessor: "CommonKwargs"
    TaskType: "CommonKwargs"
    Model: "CommonKwargs"
    Undefined: "CommonKwargs"
    Backend: "CommonKwargs"
    Pytorch: "CommonKwargs"
    Tensorflow: "CommonKwargs"
    SampleData: "CommonKwargs"
    Onnx: "CommonKwargs"
    LoadType: "CommonKwargs"
    DataType: "CommonKwargs"
    Tokenizer: "CommonKwargs"
    TokenizerName: "CommonKwargs"
    FeatureExtractor: "CommonKwargs"
    FeatureExtractorName: "CommonKwargs"
    Image: "CommonKwargs"
    Text: "CommonKwargs"
    VowpalArgs: "CommonKwargs"
    BaseVersion: "CommonKwargs"
    SampleDataInterfaceType: "CommonKwargs"

    @staticmethod
    def from_string(s: str) -> Optional["CommonKwargs"]:
        """Return the CommonKwargs enum from a string.

        Args:
            s:
                The string representation of the CommonKwargs.

        Returns:
            The CommonKwargs enum.
        """

    def as_string(self) -> str:
        """Return the string representation of the CommonKwargs.

        Returns:
            String representation of the CommonKwargs.
        """

as_string()

Return the string representation of the CommonKwargs.

Returns:

Type Description
str

String representation of the CommonKwargs.
Source code in python/opsml/types/_types.pyi 
46
47
48
49
50
51
def as_string(self) -> str:
    """Return the string representation of the CommonKwargs.

    Returns:
        String representation of the CommonKwargs.
    """

from_string(s) staticmethod

Return the CommonKwargs enum from a string.

Parameters:

Name Type Description Default
s str

The string representation of the CommonKwargs.

 required

Returns:

Type Description
Optional[CommonKwargs]

The CommonKwargs enum.
Source code in python/opsml/types/_types.pyi 
34
35
36
37
38
39
40
41
42
43
44
@staticmethod
def from_string(s: str) -> Optional["CommonKwargs"]:
    """Return the CommonKwargs enum from a string.

    Args:
        s:
            The string representation of the CommonKwargs.

    Returns:
        The CommonKwargs enum.
    """

DriftArgs

Source code in python/opsml/types/_types.pyi 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
class DriftArgs:
    def __init__(self, active: bool = True, deactivate_others: bool = False) -> None:
        """Define a drift config

        Args:
            active (bool):
                Whether to set the drift profile to active
            deactivate_others (bool):
                Whether to deactivate all other drift profiles of the same space and name
        """

    @property
    def active(self) -> bool:
        """Return the active status of the drift profile."""

    @property
    def deactivate_others(self) -> bool:
        """Return the deactivate_others status of the drift profile."""

active property

Return the active status of the drift profile.

deactivate_others property

Return the deactivate_others status of the drift profile.

__init__(active=True, deactivate_others=False)

Define a drift config

Parameters:

Name Type Description Default
active bool

Whether to set the drift profile to active

 True
deactivate_others bool

Whether to deactivate all other drift profiles of the same space and name

 False
Source code in python/opsml/types/_types.pyi 
194
195
196
197
198
199
200
201
202
def __init__(self, active: bool = True, deactivate_others: bool = False) -> None:
    """Define a drift config

    Args:
        active (bool):
            Whether to set the drift profile to active
        deactivate_others (bool):
            Whether to deactivate all other drift profiles of the same space and name
    """

DriftProfileMap

Source code in python/opsml/types/_types.pyi 
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
class DriftProfileMap:
    def __init__(self) -> None:
        """Creates an empty drift profile map"""

    def add_profile(self, alias: str, profile: Any) -> None:
        """Add a drift profile to the map

        Args:
            alias:
                Alias to use for the drift profile
            profile:
                Drift profile to add
        """

    def __getitem__(self, key: str) -> Any:
        """Returns the drift profile at the given key"""

    def is_empty(self) -> bool:
        """Returns whether the drift profile map is empty

        Returns:
            True if the drift profile map is empty, False otherwise
        """

__getitem__(key)

Returns the drift profile at the given key

Source code in python/opsml/types/_types.pyi 
226
227
def __getitem__(self, key: str) -> Any:
    """Returns the drift profile at the given key"""

__init__()

Creates an empty drift profile map

Source code in python/opsml/types/_types.pyi 
213
214
def __init__(self) -> None:
    """Creates an empty drift profile map"""

add_profile(alias, profile)

Add a drift profile to the map

Parameters:

Name Type Description Default
alias str

Alias to use for the drift profile

 required
profile Any

Drift profile to add

 required
Source code in python/opsml/types/_types.pyi 
216
217
218
219
220
221
222
223
224
def add_profile(self, alias: str, profile: Any) -> None:
    """Add a drift profile to the map

    Args:
        alias:
            Alias to use for the drift profile
        profile:
            Drift profile to add
    """

is_empty()

Returns whether the drift profile map is empty

Returns:

Type Description
bool

True if the drift profile map is empty, False otherwise
Source code in python/opsml/types/_types.pyi 
229
230
231
232
233
234
def is_empty(self) -> bool:
    """Returns whether the drift profile map is empty

    Returns:
        True if the drift profile map is empty, False otherwise
    """

DriftProfileUri

Source code in python/opsml/types/_types.pyi 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
class DriftProfileUri:
    root_dir: Path
    uri: Path
    drift_type: DriftType

    def __init__(self, uri: Path, drift_type: DriftType) -> None:
        """Define a drift profile

        Args:
            root_dir:
                The root directory of the drift profile
            uri:
                The relative path to the drift profile
            drift_type:
                Drift profile type
        """

__init__(uri, drift_type)

Define a drift profile

Parameters:

Name Type Description Default
root_dir

The root directory of the drift profile

 required
uri Path

The relative path to the drift profile

 required
drift_type DriftType

Drift profile type

 required
Source code in python/opsml/types/_types.pyi 
181
182
183
184
185
186
187
188
189
190
191
def __init__(self, uri: Path, drift_type: DriftType) -> None:
    """Define a drift profile

    Args:
        root_dir:
            The root directory of the drift profile
        uri:
            The relative path to the drift profile
        drift_type:
            Drift profile type
    """

SaveName

Source code in python/opsml/types/_types.pyi 
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
class SaveName:
    Card: "SaveName"
    Audit: "SaveName"
    ModelMetadata: "SaveName"
    Model: "SaveName"
    Preprocessor: "SaveName"
    OnnxModel: "SaveName"
    SampleModelData: "SaveName"
    DataProfile: "SaveName"
    Data: "SaveName"
    Profile: "SaveName"
    Artifacts: "SaveName"
    QuantizedModel: "SaveName"
    Tokenizer: "SaveName"
    FeatureExtractor: "SaveName"
    Metadata: "SaveName"
    Graphs: "SaveName"
    OnnxConfig: "SaveName"
    Dataset: "SaveName"
    DriftProfile: "SaveName"

    @staticmethod
    def from_string(s: str) -> Optional["SaveName"]:
        """Return the SaveName enum from a string.

        Args:
            s:
                The string representation of the SaveName.

        Returns:
            The SaveName enum.
        """

    def as_string(self) -> str:
        """Return the string representation of the SaveName.

        Returns:
            String representation of the SaveName.
        """

    def __str__(self):
        """Return a string representation of the SaveName.

        Returns:
            String representation of the SaveName.
        """

__str__()

Return a string representation of the SaveName.

Returns:

Type Description

String representation of the SaveName.
Source code in python/opsml/types/_types.pyi 
93
94
95
96
97
98
def __str__(self):
    """Return a string representation of the SaveName.

    Returns:
        String representation of the SaveName.
    """

as_string()

Return the string representation of the SaveName.

Returns:

Type Description
str

String representation of the SaveName.
Source code in python/opsml/types/_types.pyi 
86
87
88
89
90
91
def as_string(self) -> str:
    """Return the string representation of the SaveName.

    Returns:
        String representation of the SaveName.
    """

from_string(s) staticmethod

Return the SaveName enum from a string.

Parameters:

Name Type Description Default
s str

The string representation of the SaveName.

 required

Returns:

Type Description
Optional[SaveName]

The SaveName enum.
Source code in python/opsml/types/_types.pyi 
74
75
76
77
78
79
80
81
82
83
84
@staticmethod
def from_string(s: str) -> Optional["SaveName"]:
    """Return the SaveName enum from a string.

    Args:
        s:
            The string representation of the SaveName.

    Returns:
        The SaveName enum.
    """

SaverPath

Source code in python/opsml/types/_types.pyi 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
class SaverPath:
    path: Path

    def __init__(
        self,
        parent: Path,
        child: Optional[Path],
        filename: Optional[SaveName],
        extension: Optional[Suffix],
    ) -> None:
        """Helper for creating paths for saving artifacts.

        Args:
            parent (Path):
                The parent path.
            child (Path | None):
                The child path.
            filename (SaveName | None):
                The filename.
            extension (Suffix | None):
                The extension.
        """

__init__(parent, child, filename, extension)

Helper for creating paths for saving artifacts.

Parameters:

Name Type Description Default
parent Path

The parent path.

 required
child Path | None

The child path.

 required
filename SaveName | None

The filename.

 required
extension Suffix | None

The extension.

 required
Source code in python/opsml/types/_types.pyi 
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def __init__(
    self,
    parent: Path,
    child: Optional[Path],
    filename: Optional[SaveName],
    extension: Optional[Suffix],
) -> None:
    """Helper for creating paths for saving artifacts.

    Args:
        parent (Path):
            The parent path.
        child (Path | None):
            The child path.
        filename (SaveName | None):
            The filename.
        extension (Suffix | None):
            The extension.
    """

Suffix

Source code in python/opsml/types/_types.pyi 
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
class Suffix:
    Onnx: "Suffix"
    Parquet: "Suffix"
    Zarr: "Suffix"
    Joblib: "Suffix"
    Html: "Suffix"
    Json: "Suffix"
    Ckpt: "Suffix"
    Pt: "Suffix"
    Text: "Suffix"
    Catboost: "Suffix"
    Jsonl: "Suffix"
    Empty: "Suffix"
    Dmatrix: "Suffix"
    Model: "Suffix"

    @staticmethod
    def from_string(s: str) -> Optional["Suffix"]:
        """Return the Suffix enum from a string.

        Args:
            s:
                The string representation of the Suffix.

        Returns:
            The Suffix enum.
        """

    def as_string(self) -> str:
        """Return the string representation of the Suffix.

        Returns:
            String representation of the Suffix.
        """

    def __str__(self):
        """Return a string representation of the Suffix.

        Returns:
            String representation of the Suffix.
        """

__str__()

Return a string representation of the Suffix.

Returns:

Type Description

String representation of the Suffix.
Source code in python/opsml/types/_types.pyi 
135
136
137
138
139
140
def __str__(self):
    """Return a string representation of the Suffix.

    Returns:
        String representation of the Suffix.
    """

as_string()

Return the string representation of the Suffix.

Returns:

Type Description
str

String representation of the Suffix.
Source code in python/opsml/types/_types.pyi 
128
129
130
131
132
133
def as_string(self) -> str:
    """Return the string representation of the Suffix.

    Returns:
        String representation of the Suffix.
    """

from_string(s) staticmethod

Return the Suffix enum from a string.

Parameters:

Name Type Description Default
s str

The string representation of the Suffix.

 required

Returns:

Type Description
Optional[Suffix]

The Suffix enum.
Source code in python/opsml/types/_types.pyi 
116
117
118
119
120
121
122
123
124
125
126
@staticmethod
def from_string(s: str) -> Optional["Suffix"]:
    """Return the Suffix enum from a string.

    Args:
        s:
            The string representation of the Suffix.

    Returns:
        The Suffix enum.
    """