ModelTrainingResults¶

class oci.ai_anomaly_detection.models.ModelTrainingResults(**kwargs)¶

Bases: object

Specifies the details for an Anomaly Detection model trained with MSET.

Attributes

`ALGORITHM_MULTIVARIATE_MSET`	A constant which can be used with the algorithm property of a ModelTrainingResults.
`ALGORITHM_UNIVARIATE_OCSVM`	A constant which can be used with the algorithm property of a ModelTrainingResults.
`algorithm`	Gets the algorithm of this ModelTrainingResults.
`fap`	[Required] Gets the fap of this ModelTrainingResults.
`is_training_goal_achieved`	Gets the is_training_goal_achieved of this ModelTrainingResults.
`multivariate_fap`	Gets the multivariate_fap of this ModelTrainingResults.
`row_reduction_details`	Gets the row_reduction_details of this ModelTrainingResults.
`signal_details`	Gets the signal_details of this ModelTrainingResults.
`warning`	Gets the warning of this ModelTrainingResults.
`window_size`	Gets the window_size of this ModelTrainingResults.

Methods

__init__(**kwargs) Initializes a new ModelTrainingResults object with values from keyword arguments.

ALGORITHM_MULTIVARIATE_MSET = 'MULTIVARIATE_MSET'¶: A constant which can be used with the algorithm property of a ModelTrainingResults. This constant has a value of “MULTIVARIATE_MSET”

ALGORITHM_UNIVARIATE_OCSVM = 'UNIVARIATE_OCSVM'¶: A constant which can be used with the algorithm property of a ModelTrainingResults. This constant has a value of “UNIVARIATE_OCSVM”

__init__(**kwargs)¶

Initializes a new ModelTrainingResults object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

fap (float) – The value to assign to the fap property of this ModelTrainingResults.
multivariate_fap (float) – The value to assign to the multivariate_fap property of this ModelTrainingResults.
algorithm (str) – The value to assign to the algorithm property of this ModelTrainingResults. Allowed values for this property are: “MULTIVARIATE_MSET”, “UNIVARIATE_OCSVM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
window_size (int) – The value to assign to the window_size property of this ModelTrainingResults.
is_training_goal_achieved (bool) – The value to assign to the is_training_goal_achieved property of this ModelTrainingResults.
warning (str) – The value to assign to the warning property of this ModelTrainingResults.
signal_details (list[oci.ai_anomaly_detection.models.PerSignalDetails]) – The value to assign to the signal_details property of this ModelTrainingResults.
row_reduction_details (oci.ai_anomaly_detection.models.RowReductionDetails) – The value to assign to the row_reduction_details property of this ModelTrainingResults.

algorithm¶

Gets the algorithm of this ModelTrainingResults. Actual algorithm used to train the model

Allowed values for this property are: “MULTIVARIATE_MSET”, “UNIVARIATE_OCSVM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The algorithm of this ModelTrainingResults.
Return type:	str

fap¶

[Required] Gets the fap of this ModelTrainingResults. The final-achieved model accuracy metric on individual value level

Returns:	The fap of this ModelTrainingResults.
Return type:	float

is_training_goal_achieved¶

Gets the is_training_goal_achieved of this ModelTrainingResults. A boolean value to indicate if train goal/targetFap is achieved for trained model

Returns:	The is_training_goal_achieved of this ModelTrainingResults.
Return type:	bool

multivariate_fap¶

Gets the multivariate_fap of this ModelTrainingResults. The model accuracy metric on timestamp level.

Returns:	The multivariate_fap of this ModelTrainingResults.
Return type:	float

row_reduction_details¶

Gets the row_reduction_details of this ModelTrainingResults.

Returns:	The row_reduction_details of this ModelTrainingResults.
Return type:	oci.ai_anomaly_detection.models.RowReductionDetails

signal_details¶

Gets the signal_details of this ModelTrainingResults. The list of signal details.

Returns:	The signal_details of this ModelTrainingResults.
Return type:	list[oci.ai_anomaly_detection.models.PerSignalDetails]

warning¶

Gets the warning of this ModelTrainingResults. A warning message to explain the reason when targetFap cannot be achieved for trained model

Returns:	The warning of this ModelTrainingResults.
Return type:	str

window_size¶

Gets the window_size of this ModelTrainingResults. Window size defined during training or deduced by the algorithm.

Returns:	The window_size of this ModelTrainingResults.
Return type:	int