Package com.google.cloud.aiplatform.v1

Class FeatureStatsAnomaly

  • All Implemented Interfaces:
    FeatureStatsAnomalyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class FeatureStatsAnomaly
extends com.google.protobuf.GeneratedMessageV3
implements FeatureStatsAnomalyOrBuilder
     Stats and Anomaly generated at specific timestamp for specific Feature.
 The start_time and end_time are used to define the time range of the dataset
 that current stats belongs to, e.g. prediction traffic is bucketed into
 prediction datasets by time window. If the Dataset is not defined by time
 window, start_time = end_time. Timestamp of the stats and anomalies always
 refers to end_time. Raw stats and anomalies are stored in stats_uri or
 anomaly_uri in the tensorflow defined protos. Field data_stats contains
 almost identical information with the raw stats in Vertex AI
 defined proto, for UI to display.
    Protobuf type google.cloud.aiplatform.v1.FeatureStatsAnomaly
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FeatureStatsAnomaly.Builder
      Stats and Anomaly generated at specific timestamp for specific Feature.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • ANOMALY_URI_FIELD_NUMBER

        public static final int ANOMALY_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISTRIBUTION_DEVIATION_FIELD_NUMBER

        public static final int DISTRIBUTION_DEVIATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANOMALY_DETECTION_THRESHOLD_FIELD_NUMBER

        public static final int ANOMALY_DETECTION_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_TIME_FIELD_NUMBER

        public static final int START_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getScore

        public double getScore()
         Feature importance score, only populated when cross-feature monitoring is
 enabled. For now only used to represent feature attribution score within
 range [0, 1] for
 [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW]
 and
 [ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT][google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT].
        double score = 1;
        Specified by:
        getScore in interface FeatureStatsAnomalyOrBuilder
        Returns:
        The score.

      • getStatsUri

        public String getStatsUri()
         Path of the stats file for current feature values in Cloud Storage bucket.
 Format: gs://<bucket_name>/<object_name>/stats.
 Example: gs://monitoring_bucket/feature_name/stats.
 Stats are stored as binary format with Protobuf message
 [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
        string stats_uri = 3;
        Specified by:
        getStatsUri in interface FeatureStatsAnomalyOrBuilder
        Returns:
        The statsUri.

      • getStatsUriBytes

        public com.google.protobuf.ByteString getStatsUriBytes()
         Path of the stats file for current feature values in Cloud Storage bucket.
 Format: gs://<bucket_name>/<object_name>/stats.
 Example: gs://monitoring_bucket/feature_name/stats.
 Stats are stored as binary format with Protobuf message
 [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).
        string stats_uri = 3;
        Specified by:
        getStatsUriBytes in interface FeatureStatsAnomalyOrBuilder
        Returns:
        The bytes for statsUri.

      • getAnomalyUri

        public String getAnomalyUri()
         Path of the anomaly file for current feature values in Cloud Storage
 bucket.
 Format: gs://<bucket_name>/<object_name>/anomalies.
 Example: gs://monitoring_bucket/feature_name/anomalies.
 Stats are stored as binary format with Protobuf message
 Anoamlies are stored as binary format with Protobuf message
 [tensorflow.metadata.v0.AnomalyInfo]
 (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
        string anomaly_uri = 4;
        Specified by:
        getAnomalyUri in interface FeatureStatsAnomalyOrBuilder
        Returns:
        The anomalyUri.

      • getAnomalyUriBytes

        public com.google.protobuf.ByteString getAnomalyUriBytes()
         Path of the anomaly file for current feature values in Cloud Storage
 bucket.
 Format: gs://<bucket_name>/<object_name>/anomalies.
 Example: gs://monitoring_bucket/feature_name/anomalies.
 Stats are stored as binary format with Protobuf message
 Anoamlies are stored as binary format with Protobuf message
 [tensorflow.metadata.v0.AnomalyInfo]
 (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto).
        string anomaly_uri = 4;
        Specified by:
        getAnomalyUriBytes in interface FeatureStatsAnomalyOrBuilder
        Returns:
        The bytes for anomalyUri.

      • 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 = 5;
        Specified by:
        getDistributionDeviation in interface FeatureStatsAnomalyOrBuilder
        Returns:
        The distributionDeviation.

      • getAnomalyDetectionThreshold

        public double getAnomalyDetectionThreshold()
         This is the threshold used when detecting anomalies.
 The threshold can be changed by user, so this one might be different from
 [ThresholdConfig.value][google.cloud.aiplatform.v1.ThresholdConfig.value].
        double anomaly_detection_threshold = 9;
        Specified by:
        getAnomalyDetectionThreshold in interface FeatureStatsAnomalyOrBuilder
        Returns:
        The anomalyDetectionThreshold.

      • hasStartTime

        public boolean hasStartTime()
         The start timestamp of window where stats were generated.
 For objectives where time window doesn't make sense (e.g. Featurestore
 Snapshot Monitoring), start_time is only used to indicate the monitoring
 intervals, so it always equals to (end_time - monitoring_interval).
        .google.protobuf.Timestamp start_time = 7;
        Specified by:
        hasStartTime in interface FeatureStatsAnomalyOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         The start timestamp of window where stats were generated.
 For objectives where time window doesn't make sense (e.g. Featurestore
 Snapshot Monitoring), start_time is only used to indicate the monitoring
 intervals, so it always equals to (end_time - monitoring_interval).
        .google.protobuf.Timestamp start_time = 7;
        Specified by:
        getStartTime in interface FeatureStatsAnomalyOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         The start timestamp of window where stats were generated.
 For objectives where time window doesn't make sense (e.g. Featurestore
 Snapshot Monitoring), start_time is only used to indicate the monitoring
 intervals, so it always equals to (end_time - monitoring_interval).
        .google.protobuf.Timestamp start_time = 7;
        Specified by:
        getStartTimeOrBuilder in interface FeatureStatsAnomalyOrBuilder

      • hasEndTime

        public boolean hasEndTime()
         The end timestamp of window where stats were generated.
 For objectives where time window doesn't make sense (e.g. Featurestore
 Snapshot Monitoring), end_time indicates the timestamp of the data used to
 generate stats (e.g. timestamp we take snapshots for feature values).
        .google.protobuf.Timestamp end_time = 8;
        Specified by:
        hasEndTime in interface FeatureStatsAnomalyOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         The end timestamp of window where stats were generated.
 For objectives where time window doesn't make sense (e.g. Featurestore
 Snapshot Monitoring), end_time indicates the timestamp of the data used to
 generate stats (e.g. timestamp we take snapshots for feature values).
        .google.protobuf.Timestamp end_time = 8;
        Specified by:
        getEndTime in interface FeatureStatsAnomalyOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         The end timestamp of window where stats were generated.
 For objectives where time window doesn't make sense (e.g. Featurestore
 Snapshot Monitoring), end_time indicates the timestamp of the data used to
 generate stats (e.g. timestamp we take snapshots for feature values).
        .google.protobuf.Timestamp end_time = 8;
        Specified by:
        getEndTimeOrBuilder in interface FeatureStatsAnomalyOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static FeatureStatsAnomaly parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FeatureStatsAnomaly parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FeatureStatsAnomaly parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FeatureStatsAnomaly parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FeatureStatsAnomaly parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FeatureStatsAnomaly parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FeatureStatsAnomaly parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public FeatureStatsAnomaly.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public FeatureStatsAnomaly.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected FeatureStatsAnomaly.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<FeatureStatsAnomaly> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public FeatureStatsAnomaly getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder