Share via

ModelInfo Class

  • Reference

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.

Inheritance
azure.ai.anomalydetector._model_base.Model
ModelInfo

Constructor

ModelInfo(*args: Any, **kwargs: Any)

Variables

Name Description
data_source
str

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.
data_schema
str or DataSchema

Data schema of input data source: OneTable or MultiTable. The default DataSchema is OneTable. Known values are: "OneTable" and "MultiTable".
start_time
datetime

A required field, indicating the start time of training data, which should be date-time of ISO 8601 format. Required.
end_time
datetime

A required field, indicating the end time of training data, which should be date-time of ISO 8601 format. Required.
display_name
str

An optional field. The display name of the model whose maximum length is 24 characters.
sliding_window
int

An optional field, indicating how many previous timestamps will be used to detect whether the timestamp is anomaly or not.
align_policy
AlignPolicy

An optional field, indicating the manner to align multiple variables.
status
str or ModelStatus

Model status. One of CREATED, RUNNING, READY, and FAILED. Known values are: "CREATED", "RUNNING", "READY", and "FAILED".
errors
list[ErrorResponse]

Error messages when failed to create a model.
diagnostics_info
DiagnosticsInfo

Diagnostics information to help inspect the states of model or variable.

Methods

clear
copy
get
items
keys
pop
popitem
setdefault
update
values

clear 

clear() -> None

copy 

copy()

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView

keys 

keys() -> KeysView

pop 

pop(key: ~typing.Any, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem 

popitem() -> Tuple[str, Any]

setdefault 

setdefault(key: ~typing.Any, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView

Attributes

align_policy

An optional field, indicating the manner to align multiple variables.

align_policy: _models.AlignPolicy | None

data_schema

OneTable or MultiTable. The default DataSchema is OneTable. Known values are: "OneTable" and "MultiTable".

data_schema: str | _models.DataSchema | None

data_source

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.

data_source: str

diagnostics_info

Diagnostics information to help inspect the states of model or variable.

diagnostics_info: _models.DiagnosticsInfo | None

display_name

An optional field. The display name of the model whose maximum length is 24 characters.

display_name: str | None

end_time

A required field, indicating the end time of training data, which should be date-time of ISO 8601 format. Required.

end_time: datetime

errors

Error messages when failed to create a model.

errors: List[_models.ErrorResponse] | None

sliding_window

An optional field, indicating how many previous timestamps will be used to detect whether the timestamp is anomaly or not.

sliding_window: int | None

start_time

A required field, indicating the start time of training data, which should be date-time of ISO 8601 format. Required.

start_time: datetime

status

"CREATED", "RUNNING", "READY", and "FAILED".

status: str | _models.ModelStatus | None