/
azure.ai.anomalydetector.models.ModelInfo.yml
193 lines (171 loc) · 6.39 KB
/
azure.ai.anomalydetector.models.ModelInfo.yml
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
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
159
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
185
186
187
188
189
190
191
192
193
### YamlMime:PythonClass
uid: azure.ai.anomalydetector.models.ModelInfo
name: ModelInfo
fullName: azure.ai.anomalydetector.models.ModelInfo
module: azure.ai.anomalydetector.models
inheritances:
- azure.ai.anomalydetector._model_base.Model
summary: 'Training result of a model including its status, errors and diagnostics
information.
Readonly variables are only populated by the server, and will be ignored when sending
a request.
All required parameters must be populated in order to send to Azure.'
constructor:
syntax: 'ModelInfo(*args: Any, **kwargs: Any)'
variables:
- description: 'Source link to the input data to indicate an accessible Azure storage
Uri,
either pointed to an Azure blob storage folder, or pointed to a CSV file in
Azure blob storage based on you data schema selection. Required.'
name: data_source
types:
- <xref:str>
- description: 'Data schema of input data source: OneTable or MultiTable. The default
DataSchema is OneTable. Known values are: "OneTable" and "MultiTable".'
name: data_schema
types:
- <xref:str>
- <xref:azure.ai.anomalydetector.models.DataSchema>
- description: 'A required field, indicating the start time of training data, which
should be
date-time of ISO 8601 format. Required.'
name: start_time
types:
- <xref:datetime.datetime>
- description: 'A required field, indicating the end time of training data, which
should be
date-time of ISO 8601 format. Required.'
name: end_time
types:
- <xref:datetime.datetime>
- description: 'An optional field. The display name of the model whose maximum length
is 24
characters.'
name: display_name
types:
- <xref:str>
- description: 'An optional field, indicating how many previous timestamps will be
used
to
detect whether the timestamp is anomaly or not.'
name: sliding_window
types:
- <xref:int>
- description: An optional field, indicating the manner to align multiple variables.
name: align_policy
types:
- <xref:azure.ai.anomalydetector.models.AlignPolicy>
- description: 'Model status. One of CREATED, RUNNING, READY, and FAILED. Known values
are:
"CREATED", "RUNNING", "READY", and "FAILED".'
name: status
types:
- <xref:str>
- <xref:azure.ai.anomalydetector.models.ModelStatus>
- description: Error messages when failed to create a model.
name: errors
types:
- <xref:list>[<xref:azure.ai.anomalydetector.models.ErrorResponse>]
- description: 'Diagnostics information to help inspect the states of model or
variable.'
name: diagnostics_info
types:
- <xref:azure.ai.anomalydetector.models.DiagnosticsInfo>
methods:
- uid: azure.ai.anomalydetector.models.ModelInfo.clear
name: clear
signature: clear() -> None
- uid: azure.ai.anomalydetector.models.ModelInfo.copy
name: copy
signature: copy()
- uid: azure.ai.anomalydetector.models.ModelInfo.get
name: get
signature: 'get(key: str, default: Any = None) -> Any'
parameters:
- name: key
isRequired: true
- name: default
defaultValue: None
- uid: azure.ai.anomalydetector.models.ModelInfo.items
name: items
signature: items() -> ItemsView
- uid: azure.ai.anomalydetector.models.ModelInfo.keys
name: keys
signature: keys() -> KeysView
- uid: azure.ai.anomalydetector.models.ModelInfo.pop
name: pop
signature: 'pop(key: ~typing.Any, default: ~typing.Any = <object object>) -> Any'
parameters:
- name: key
isRequired: true
- name: default
- uid: azure.ai.anomalydetector.models.ModelInfo.popitem
name: popitem
signature: popitem() -> Tuple[str, Any]
- uid: azure.ai.anomalydetector.models.ModelInfo.setdefault
name: setdefault
signature: 'setdefault(key: ~typing.Any, default: ~typing.Any = <object object>)
-> Any'
parameters:
- name: key
isRequired: true
- name: default
- uid: azure.ai.anomalydetector.models.ModelInfo.update
name: update
signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.ai.anomalydetector.models.ModelInfo.values
name: values
signature: values() -> ValuesView
attributes:
- uid: azure.ai.anomalydetector.models.ModelInfo.align_policy
name: align_policy
summary: An optional field, indicating the manner to align multiple variables.
signature: 'align_policy: _models.AlignPolicy | None'
- uid: azure.ai.anomalydetector.models.ModelInfo.data_schema
name: data_schema
summary: 'OneTable or MultiTable. The default
DataSchema is OneTable. Known values are: "OneTable" and "MultiTable".'
signature: 'data_schema: str | _models.DataSchema | None'
- uid: azure.ai.anomalydetector.models.ModelInfo.data_source
name: data_source
summary: 'Source link to the input data to indicate an accessible Azure storage
Uri,
either pointed to an Azure blob storage folder, or pointed to a CSV file in
Azure blob storage based on you data schema selection. Required.'
signature: 'data_source: str'
- uid: azure.ai.anomalydetector.models.ModelInfo.diagnostics_info
name: diagnostics_info
summary: Diagnostics information to help inspect the states of model or variable.
signature: 'diagnostics_info: _models.DiagnosticsInfo | None'
- uid: azure.ai.anomalydetector.models.ModelInfo.display_name
name: display_name
summary: 'An optional field. The display name of the model whose maximum length
is 24
characters.'
signature: 'display_name: str | None'
- uid: azure.ai.anomalydetector.models.ModelInfo.end_time
name: end_time
summary: 'A required field, indicating the end time of training data, which should
be
date-time of ISO 8601 format. Required.'
signature: 'end_time: datetime'
- uid: azure.ai.anomalydetector.models.ModelInfo.errors
name: errors
summary: Error messages when failed to create a model.
signature: 'errors: List[_models.ErrorResponse] | None'
- uid: azure.ai.anomalydetector.models.ModelInfo.sliding_window
name: sliding_window
summary: 'An optional field, indicating how many previous timestamps will be used
to
detect whether the timestamp is anomaly or not.'
signature: 'sliding_window: int | None'
- uid: azure.ai.anomalydetector.models.ModelInfo.start_time
name: start_time
summary: 'A required field, indicating the start time of training data, which should
be
date-time of ISO 8601 format. Required.'
signature: 'start_time: datetime'
- uid: azure.ai.anomalydetector.models.ModelInfo.status
name: status
summary: '"CREATED", "RUNNING", "READY", and "FAILED".'
signature: 'status: str | _models.ModelStatus | None'