Class ModelMonitoringObjectiveConfig.ExplanationConfig (3.2.0)

public static final class ModelMonitoringObjectiveConfig.ExplanationConfig extends 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ModelMonitoringObjectiveConfig.ExplanationConfig

Static Fields

ENABLE_FEATURE_ATTRIBUTES_FIELD_NUMBER

public static final int ENABLE_FEATURE_ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int

EXPLANATION_BASELINE_FIELD_NUMBER

public static final int EXPLANATION_BASELINE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ModelMonitoringObjectiveConfig.ExplanationConfig getDefaultInstance()
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilder()
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

newBuilder(ModelMonitoringObjectiveConfig.ExplanationConfig prototype)

public static ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilder(ModelMonitoringObjectiveConfig.ExplanationConfig prototype)
Parameter
NameDescription
prototypeModelMonitoringObjectiveConfig.ExplanationConfig
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

parseDelimitedFrom(InputStream input)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ModelMonitoringObjectiveConfig.ExplanationConfig> parser()
Returns
TypeDescription
Parser<ExplanationConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ModelMonitoringObjectiveConfig.ExplanationConfig getDefaultInstanceForType()
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig

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;

Returns
TypeDescription
boolean

The enableFeatureAttributes.

getExplanationBaseline()

public ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline getExplanationBaseline()

Predictions generated by the BatchPredictionJob using baseline dataset.

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

Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaseline

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;

Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaselineOrBuilder

getParserForType()

public Parser<ModelMonitoringObjectiveConfig.ExplanationConfig> getParserForType()
Returns
TypeDescription
Parser<ExplanationConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasExplanationBaseline()

public boolean hasExplanationBaseline()

Predictions generated by the BatchPredictionJob using baseline dataset.

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

Returns
TypeDescription
boolean

Whether the explanationBaseline field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilderForType()
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder toBuilder()
Returns
TypeDescription
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException