Package com.google.cloud.aiplatform.v1

Class ModelMonitoringObjectiveConfig.ExplanationConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig

All Implemented Interfaces:

ModelMonitoringObjectiveConfig.ExplanationConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

ModelMonitoringObjectiveConfig

public static final class ModelMonitoringObjectiveConfig.ExplanationConfig
extends com.google.protobuf.GeneratedMessageV3
implements ModelMonitoringObjectiveConfig.ExplanationConfigOrBuilder

 The config for integrating with Vertex Explainable AI. Only applicable if
 the Model has explanation_spec populated.
 

Protobuf type google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelMonitoringObjectiveConfig.ExplanationConfig.Builder	The config for integrating with Vertex Explainable AI.
static class	ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline	Output from [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob] for Model Monitoring baseline dataset, which can be used to generate baseline attribution scores.
static interface	ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaselineOrBuilder

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 Summary

Fields

Modifier and Type	Field	Description
static int	ENABLE_FEATURE_ATTRIBUTES_FIELD_NUMBER
static int	EXPLANATION_BASELINE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ModelMonitoringObjectiveConfig.ExplanationConfig	getDefaultInstance()
ModelMonitoringObjectiveConfig.ExplanationConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getEnableFeatureAttributes()	If want to analyze the Vertex Explainable AI feature attribute scores or not.
ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline	getExplanationBaseline()	Predictions generated by the BatchPredictionJob using baseline dataset.
ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaselineOrBuilder	getExplanationBaselineOrBuilder()	Predictions generated by the BatchPredictionJob using baseline dataset.
com.google.protobuf.Parser<ModelMonitoringObjectiveConfig.ExplanationConfig>	getParserForType()
int	getSerializedSize()
boolean	hasExplanationBaseline()	Predictions generated by the BatchPredictionJob using baseline dataset.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ModelMonitoringObjectiveConfig.ExplanationConfig.Builder	newBuilder()
static ModelMonitoringObjectiveConfig.ExplanationConfig.Builder	newBuilder(ModelMonitoringObjectiveConfig.ExplanationConfig prototype)
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder	newBuilderForType()
protected ModelMonitoringObjectiveConfig.ExplanationConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseDelimitedFrom(InputStream input)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(byte[] data)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(com.google.protobuf.ByteString data)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(InputStream input)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(ByteBuffer data)
static ModelMonitoringObjectiveConfig.ExplanationConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ModelMonitoringObjectiveConfig.ExplanationConfig>	parser()
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

ENABLE_FEATURE_ATTRIBUTES_FIELD_NUMBER

public static final int ENABLE_FEATURE_ATTRIBUTES_FIELD_NUMBER

See Also:

Constant Field Values

EXPLANATION_BASELINE_FIELD_NUMBER

public static final int EXPLANATION_BASELINE_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

getEnableFeatureAttributes

public boolean getEnableFeatureAttributes()

 If want to analyze the Vertex Explainable AI feature attribute scores or
 not. If set to true, Vertex AI will log the feature attributions from
 explain response and do the skew/drift detection for them.
 

bool enable_feature_attributes = 1;

Specified by:

getEnableFeatureAttributes in interface ModelMonitoringObjectiveConfig.ExplanationConfigOrBuilder

Returns:

The enableFeatureAttributes.

hasExplanationBaseline

public boolean hasExplanationBaseline()

 Predictions generated by the BatchPredictionJob using baseline dataset.
 

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Specified by:

hasExplanationBaseline in interface ModelMonitoringObjectiveConfig.ExplanationConfigOrBuilder

Returns:

Whether the explanationBaseline field is set.

getExplanationBaseline

public ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline getExplanationBaseline()

 Predictions generated by the BatchPredictionJob using baseline dataset.
 

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Specified by:

getExplanationBaseline in interface ModelMonitoringObjectiveConfig.ExplanationConfigOrBuilder

Returns:

The explanationBaseline.

getExplanationBaselineOrBuilder

public ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaselineOrBuilder getExplanationBaselineOrBuilder()

 Predictions generated by the BatchPredictionJob using baseline dataset.
 

.google.cloud.aiplatform.v1.ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline explanation_baseline = 2;

Specified by:

getExplanationBaselineOrBuilder in interface ModelMonitoringObjectiveConfig.ExplanationConfigOrBuilder

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 ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(ByteBuffer data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(ByteBuffer data,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(com.google.protobuf.ByteString data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(com.google.protobuf.ByteString data,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(byte[] data)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(byte[] data,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(InputStream input)
                                                                  throws IOException

Throws:

IOException

parseFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(InputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseDelimitedFrom(InputStream input)
                                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseDelimitedFrom(InputStream input,
                                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                           throws IOException

Throws:

IOException

parseFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                                                  throws IOException

Throws:

IOException

parseFrom

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws IOException

Throws:

IOException

newBuilderForType

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilder()

newBuilder

public static ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilder(ModelMonitoringObjectiveConfig.ExplanationConfig prototype)

toBuilder

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ModelMonitoringObjectiveConfig.ExplanationConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<ModelMonitoringObjectiveConfig.ExplanationConfig> parser()

getParserForType

public com.google.protobuf.Parser<ModelMonitoringObjectiveConfig.ExplanationConfig> 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 ModelMonitoringObjectiveConfig.ExplanationConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder