Class FeatureStatsAndAnomaly (3.55.0)

public final class FeatureStatsAndAnomaly extends GeneratedMessageV3 implements FeatureStatsAndAnomalyOrBuilder

Stats and Anomaly generated by FeatureMonitorJobs. Anomaly only includes Drift.

Protobuf type google.cloud.aiplatform.v1beta1.FeatureStatsAndAnomaly

Static Fields

DISTRIBUTION_DEVIATION_FIELD_NUMBER

public static final int DISTRIBUTION_DEVIATION_FIELD_NUMBER
Field Value
Type Description
int

DRIFT_DETECTED_FIELD_NUMBER

public static final int DRIFT_DETECTED_FIELD_NUMBER
Field Value
Type Description
int

DRIFT_DETECTION_THRESHOLD_FIELD_NUMBER

public static final int DRIFT_DETECTION_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_ID_FIELD_NUMBER

public static final int FEATURE_ID_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_MONITOR_ID_FIELD_NUMBER

public static final int FEATURE_MONITOR_ID_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_MONITOR_JOB_ID_FIELD_NUMBER

public static final int FEATURE_MONITOR_JOB_ID_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_STATS_FIELD_NUMBER

public static final int FEATURE_STATS_FIELD_NUMBER
Field Value
Type Description
int

STATS_TIME_FIELD_NUMBER

public static final int STATS_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FeatureStatsAndAnomaly getDefaultInstance()
Returns
Type Description
FeatureStatsAndAnomaly

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FeatureStatsAndAnomaly.Builder newBuilder()
Returns
Type Description
FeatureStatsAndAnomaly.Builder

newBuilder(FeatureStatsAndAnomaly prototype)

public static FeatureStatsAndAnomaly.Builder newBuilder(FeatureStatsAndAnomaly prototype)
Parameter
Name Description
prototype FeatureStatsAndAnomaly
Returns
Type Description
FeatureStatsAndAnomaly.Builder

parseDelimitedFrom(InputStream input)

public static FeatureStatsAndAnomaly parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FeatureStatsAndAnomaly parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FeatureStatsAndAnomaly parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FeatureStatsAndAnomaly parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FeatureStatsAndAnomaly parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FeatureStatsAndAnomaly parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FeatureStatsAndAnomaly parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FeatureStatsAndAnomaly parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FeatureStatsAndAnomaly parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FeatureStatsAndAnomaly parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FeatureStatsAndAnomaly parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FeatureStatsAndAnomaly parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureStatsAndAnomaly
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FeatureStatsAndAnomaly> parser()
Returns
Type Description
Parser<FeatureStatsAndAnomaly>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public FeatureStatsAndAnomaly getDefaultInstanceForType()
Returns
Type Description
FeatureStatsAndAnomaly

getDistributionDeviation()

public double getDistributionDeviation()

Deviation from the current stats to baseline stats.

  1. For categorical feature, the distribution distance is calculated by L-inifinity norm.
  2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.

double distribution_deviation = 3;

Returns
Type Description
double

The distributionDeviation.

getDriftDetected()

public boolean getDriftDetected()

If set to true, indicates current stats is detected as and comparing with baseline stats.

bool drift_detected = 5;

Returns
Type Description
boolean

The driftDetected.

getDriftDetectionThreshold()

public double getDriftDetectionThreshold()

This is the threshold used when detecting drifts, which is set in FeatureMonitor.FeatureSelectionConfig.FeatureConfig.drift_threshold

double drift_detection_threshold = 4;

Returns
Type Description
double

The driftDetectionThreshold.

getFeatureId()

public String getFeatureId()

Feature Id.

string feature_id = 1;

Returns
Type Description
String

The featureId.

getFeatureIdBytes()

public ByteString getFeatureIdBytes()

Feature Id.

string feature_id = 1;

Returns
Type Description
ByteString

The bytes for featureId.

getFeatureMonitorId()

public String getFeatureMonitorId()

The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.

string feature_monitor_id = 8;

Returns
Type Description
String

The featureMonitorId.

getFeatureMonitorIdBytes()

public ByteString getFeatureMonitorIdBytes()

The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.

string feature_monitor_id = 8;

Returns
Type Description
ByteString

The bytes for featureMonitorId.

getFeatureMonitorJobId()

public long getFeatureMonitorJobId()

The ID of the FeatureMonitorJob that generated this FeatureStatsAndAnomaly.

int64 feature_monitor_job_id = 7;

Returns
Type Description
long

The featureMonitorJobId.

getFeatureStats()

public Value getFeatureStats()

Feature stats. e.g. histogram buckets. In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.

.google.protobuf.Value feature_stats = 2;

Returns
Type Description
Value

The featureStats.

getFeatureStatsOrBuilder()

public ValueOrBuilder getFeatureStatsOrBuilder()

Feature stats. e.g. histogram buckets. In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.

.google.protobuf.Value feature_stats = 2;

Returns
Type Description
ValueOrBuilder

getParserForType()

public Parser<FeatureStatsAndAnomaly> getParserForType()
Returns
Type Description
Parser<FeatureStatsAndAnomaly>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatsTime()

public Timestamp getStatsTime()

The timestamp we take snapshot for feature values to generate stats.

.google.protobuf.Timestamp stats_time = 6;

Returns
Type Description
Timestamp

The statsTime.

getStatsTimeOrBuilder()

public TimestampOrBuilder getStatsTimeOrBuilder()

The timestamp we take snapshot for feature values to generate stats.

.google.protobuf.Timestamp stats_time = 6;

Returns
Type Description
TimestampOrBuilder

hasFeatureStats()

public boolean hasFeatureStats()

Feature stats. e.g. histogram buckets. In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.

.google.protobuf.Value feature_stats = 2;

Returns
Type Description
boolean

Whether the featureStats field is set.

hasStatsTime()

public boolean hasStatsTime()

The timestamp we take snapshot for feature values to generate stats.

.google.protobuf.Timestamp stats_time = 6;

Returns
Type Description
boolean

Whether the statsTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FeatureStatsAndAnomaly.Builder newBuilderForType()
Returns
Type Description
FeatureStatsAndAnomaly.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FeatureStatsAndAnomaly.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FeatureStatsAndAnomaly.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FeatureStatsAndAnomaly.Builder toBuilder()
Returns
Type Description
FeatureStatsAndAnomaly.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException