UnivariateChangePointDetectionOptions Class

The request of change point detection.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.ai.anomalydetector._model_base.Model

UnivariateChangePointDetectionOptions

Constructor

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

Variables

Name	Description
series	list[TimeSeriesPoint] Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result. Required.
granularity	str or TimeGranularity Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid. Required. Known values are: "yearly", "monthly", "weekly", "daily", "hourly", "minutely", "secondly", "microsecond", and "none".
custom_interval	int Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}.
period	int Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.
stable_trend_window	int Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection.
threshold	float Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted.

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

custom_interval

Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}.

custom_interval: int | None

granularity

Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid. Required. Known values are: "yearly", "monthly", "weekly", "daily", "hourly", "minutely", "secondly", "microsecond", and "none".

granularity: str | _models.TimeGranularity

period

Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.

period: int | None

series

Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result. Required.

series: List[_models.TimeSeriesPoint]

stable_trend_window

Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection.

stable_trend_window: int | None

threshold

Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted.

threshold: float | None