oracle.pgx.api.mllib

Interface VertexAnomalyDetectionModel

All Known Implementing Classes:

UnsupervisedAnomalyDetectionGraphWiseModel

public interface VertexAnomalyDetectionModel

This interface specifies which methods an object should implement in order to perform vertex anomaly detection.

Since:

23.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VertexAnomalyDetectionModel.AnomalyDetectionInferenceType

Method Summary

Modifier and Type	Method and Description
<ID> PgxFrame	evaluateAnomalyLabels(PgxGraph graph, java.lang.Iterable<PgxVertex<ID>> vertices, java.lang.String vertexAnomalyPropertyName, java.lang.Object anomalyPropertyValue, float threshold) Blocking version of evaluateAnomalyLabelsAsync(PgxGraph, Iterable, String, Object, float).
<ID> PgxFuture<PgxFrame>	evaluateAnomalyLabelsAsync(PgxGraph graph, java.lang.Iterable<PgxVertex<ID>> vertices, java.lang.String vertexAnomalyPropertyName, java.lang.Object anomalyPropertyValue, float threshold) Evaluates anomaly detection performance statistics for the specified vertices.
<ID> java.lang.Double	findAnomalyThreshold(PgxGraph graph, java.lang.Iterable<PgxVertex<ID>> vertices, float contaminationFactor) Blocking version of findAnomalyThresholdAsync(PgxGraph, Iterable, float).
<ID> PgxFuture<java.lang.Double>	findAnomalyThresholdAsync(PgxGraph graph, java.lang.Iterable<PgxVertex<ID>> vertices, float contaminationFactor) Finds an appropriate anomaly threshold for labeling the input vertices as anomalies, respecting the proportion given by the contamination factor
<ID> PgxFrame	inferAnomalyLabels(PgxGraph graph, java.lang.Iterable<PgxVertex<ID>> vertices, float threshold) Blocking version of inferAnomalyLabelsAsync(PgxGraph, Iterable, float).
<ID> PgxFuture<PgxFrame>	inferAnomalyLabelsAsync(PgxGraph graph, java.lang.Iterable<PgxVertex<ID>> vertices, float threshold) Infers the anomaly labels for the specified vertices.
<ID> PgxFrame	inferAnomalyScores(PgxGraph graph, java.lang.Iterable<PgxVertex<ID>> vertices) Blocking version of inferAnomalyScoresAsync(PgxGraph, Iterable).
<ID> PgxFuture<PgxFrame>	inferAnomalyScoresAsync(PgxGraph graph, java.lang.Iterable<PgxVertex<ID>> vertices) Infers the anomaly scores for the specified vertices.

Method Detail

evaluateAnomalyLabels

<ID> PgxFrame evaluateAnomalyLabels(PgxGraph graph,
                                    java.lang.Iterable<PgxVertex<ID>> vertices,
                                    java.lang.String vertexAnomalyPropertyName,
                                    java.lang.Object anomalyPropertyValue,
                                    float threshold)

Blocking version of evaluateAnomalyLabelsAsync(PgxGraph, Iterable, String, Object, float).

Returns:

PgxFrame containing the evaluation results.

Since:

23.2

evaluateAnomalyLabelsAsync

<ID> PgxFuture<PgxFrame> evaluateAnomalyLabelsAsync(PgxGraph graph,
                                                    java.lang.Iterable<PgxVertex<ID>> vertices,
                                                    java.lang.String vertexAnomalyPropertyName,
                                                    java.lang.Object anomalyPropertyValue,
                                                    float threshold)

Evaluates anomaly detection performance statistics for the specified vertices.

Parameters:

graph - the input graph

vertices - the vertices to produce labels to

vertexAnomalyPropertyName - the name of the vertex containing the ground truth anomaly labels

anomalyPropertyValue - the value representing anomalies in vertexAnomalyPropertyName property

threshold - the decision threshold

Returns:

PgxFrame containing the evaluation results.

Since:

23.2

findAnomalyThreshold

<ID> java.lang.Double findAnomalyThreshold(PgxGraph graph,
                                           java.lang.Iterable<PgxVertex<ID>> vertices,
                                           float contaminationFactor)

Blocking version of findAnomalyThresholdAsync(PgxGraph, Iterable, float).

Returns:

the threshold

Since:

23.2

findAnomalyThresholdAsync

<ID> PgxFuture<java.lang.Double> findAnomalyThresholdAsync(PgxGraph graph,
                                                           java.lang.Iterable<PgxVertex<ID>> vertices,
                                                           float contaminationFactor)

Finds an appropriate anomaly threshold for labeling the input vertices as anomalies, respecting the proportion given by the contamination factor

Parameters:

graph - the input graph

vertices - the vertices used to find the threshold

contaminationFactor - the expected proportion of vertices that should be labeled as anomalies

Returns:

the threshold

Since:

23.2

inferAnomalyLabels

<ID> PgxFrame inferAnomalyLabels(PgxGraph graph,
                                 java.lang.Iterable<PgxVertex<ID>> vertices,
                                 float threshold)

Blocking version of inferAnomalyLabelsAsync(PgxGraph, Iterable, float).

Returns:

PgxFrame containing the labels for each vertex.

Since:

23.2

inferAnomalyLabelsAsync

<ID> PgxFuture<PgxFrame> inferAnomalyLabelsAsync(PgxGraph graph,
                                                 java.lang.Iterable<PgxVertex<ID>> vertices,
                                                 float threshold)

Infers the anomaly labels for the specified vertices.

Parameters:

graph - the input graph

vertices - the vertices to produce labels to

threshold - the decision threshold

Returns:

PgxFrame containing the labels for each vertex.

Since:

23.2

inferAnomalyScores

<ID> PgxFrame inferAnomalyScores(PgxGraph graph,
                                 java.lang.Iterable<PgxVertex<ID>> vertices)

Blocking version of inferAnomalyScoresAsync(PgxGraph, Iterable).

Returns:

PgxFrame containing the scores for each vertex.

Since:

23.2

inferAnomalyScoresAsync

<ID> PgxFuture<PgxFrame> inferAnomalyScoresAsync(PgxGraph graph,
                                                 java.lang.Iterable<PgxVertex<ID>> vertices)

Infers the anomaly scores for the specified vertices.

Parameters:

graph - the input graph

vertices - the vertices to find anomaly scores for

Returns:

PgxFrame containing the scores for each vertex.

Since:

23.2