Class ModelMonitoringObjectiveConfig.ExplanationConfig (3.53.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
Type Description
int

EXPLANATION_BASELINE_FIELD_NUMBER

public static final int EXPLANATION_BASELINE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ModelMonitoringObjectiveConfig.ExplanationConfig getDefaultInstance()
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig

getDescriptor()

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

newBuilder()

public static ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilder()
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

newBuilder(ModelMonitoringObjectiveConfig.ExplanationConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ModelMonitoringObjectiveConfig.ExplanationConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ModelMonitoringObjectiveConfig.ExplanationConfig getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.ExplanationBaselineOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasExplanationBaseline()

public boolean hasExplanationBaseline()

Predictions generated by the BatchPredictionJob using baseline dataset.

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

Returns
Type Description
boolean

Whether the explanationBaseline 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 ModelMonitoringObjectiveConfig.ExplanationConfig.Builder newBuilderForType()
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ModelMonitoringObjectiveConfig.ExplanationConfig.Builder toBuilder()
Returns
Type Description
ModelMonitoringObjectiveConfig.ExplanationConfig.Builder

writeTo(CodedOutputStream output)

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