com.google.cloud.aiplatform.v1

Class ModelExplanation

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.ModelExplanation

All Implemented Interfaces:

ModelExplanationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ModelExplanation
extends com.google.protobuf.GeneratedMessageV3
implements ModelExplanationOrBuilder

 Aggregated explanation metrics for a Model over a set of instances.
 

Protobuf type google.cloud.aiplatform.v1.ModelExplanation

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelExplanation.Builder Aggregated explanation metrics for a Model over a set of instances.

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 and Description
static int	MEAN_ATTRIBUTIONS_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 and Description
boolean	equals(Object obj)
static ModelExplanation	getDefaultInstance()
ModelExplanation	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Attribution	getMeanAttributions(int index) Output only.
int	getMeanAttributionsCount() Output only.
List<Attribution>	getMeanAttributionsList() Output only.
AttributionOrBuilder	getMeanAttributionsOrBuilder(int index) Output only.
List<? extends AttributionOrBuilder>	getMeanAttributionsOrBuilderList() Output only.
com.google.protobuf.Parser<ModelExplanation>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ModelExplanation.Builder	newBuilder()
static ModelExplanation.Builder	newBuilder(ModelExplanation prototype)
ModelExplanation.Builder	newBuilderForType()
protected ModelExplanation.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ModelExplanation	parseDelimitedFrom(InputStream input)
static ModelExplanation	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExplanation	parseFrom(byte[] data)
static ModelExplanation	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExplanation	parseFrom(ByteBuffer data)
static ModelExplanation	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExplanation	parseFrom(com.google.protobuf.ByteString data)
static ModelExplanation	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExplanation	parseFrom(com.google.protobuf.CodedInputStream input)
static ModelExplanation	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelExplanation	parseFrom(InputStream input)
static ModelExplanation	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ModelExplanation>	parser()
ModelExplanation.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MEAN_ATTRIBUTIONS_FIELD_NUMBER

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

getMeanAttributionsList

public List<Attribution> getMeanAttributionsList()

 Output only. Aggregated attributions explaining the Model's prediction
 outputs over the set of instances. The attributions are grouped by outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 The
 [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value],
 [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value]
 and
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 fields are averaged over the test data.

 NOTE: Currently AutoML tabular classification Models produce only one
 attribution, which averages attributions over all the classes it predicts.
 [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error]
 is not populated.
 

repeated .google.cloud.aiplatform.v1.Attribution mean_attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getMeanAttributionsList in interface ModelExplanationOrBuilder

getMeanAttributionsOrBuilderList

public List<? extends AttributionOrBuilder> getMeanAttributionsOrBuilderList()

 Output only. Aggregated attributions explaining the Model's prediction
 outputs over the set of instances. The attributions are grouped by outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 The
 [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value],
 [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value]
 and
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 fields are averaged over the test data.

 NOTE: Currently AutoML tabular classification Models produce only one
 attribution, which averages attributions over all the classes it predicts.
 [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error]
 is not populated.
 

repeated .google.cloud.aiplatform.v1.Attribution mean_attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getMeanAttributionsOrBuilderList in interface ModelExplanationOrBuilder

getMeanAttributionsCount

public int getMeanAttributionsCount()

 Output only. Aggregated attributions explaining the Model's prediction
 outputs over the set of instances. The attributions are grouped by outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 The
 [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value],
 [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value]
 and
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 fields are averaged over the test data.

 NOTE: Currently AutoML tabular classification Models produce only one
 attribution, which averages attributions over all the classes it predicts.
 [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error]
 is not populated.
 

repeated .google.cloud.aiplatform.v1.Attribution mean_attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getMeanAttributionsCount in interface ModelExplanationOrBuilder

getMeanAttributions

public Attribution getMeanAttributions(int index)

 Output only. Aggregated attributions explaining the Model's prediction
 outputs over the set of instances. The attributions are grouped by outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 The
 [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value],
 [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value]
 and
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 fields are averaged over the test data.

 NOTE: Currently AutoML tabular classification Models produce only one
 attribution, which averages attributions over all the classes it predicts.
 [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error]
 is not populated.
 

repeated .google.cloud.aiplatform.v1.Attribution mean_attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getMeanAttributions in interface ModelExplanationOrBuilder

getMeanAttributionsOrBuilder

public AttributionOrBuilder getMeanAttributionsOrBuilder(int index)

 Output only. Aggregated attributions explaining the Model's prediction
 outputs over the set of instances. The attributions are grouped by outputs.

 For Models that predict only one output, such as regression Models that
 predict only one score, there is only one attibution that explains the
 predicted output. For Models that predict multiple outputs, such as
 multiclass Models that predict multiple classes, each element explains one
 specific item.
 [Attribution.output_index][google.cloud.aiplatform.v1.Attribution.output_index]
 can be used to identify which output this attribution is explaining.

 The
 [baselineOutputValue][google.cloud.aiplatform.v1.Attribution.baseline_output_value],
 [instanceOutputValue][google.cloud.aiplatform.v1.Attribution.instance_output_value]
 and
 [featureAttributions][google.cloud.aiplatform.v1.Attribution.feature_attributions]
 fields are averaged over the test data.

 NOTE: Currently AutoML tabular classification Models produce only one
 attribution, which averages attributions over all the classes it predicts.
 [Attribution.approximation_error][google.cloud.aiplatform.v1.Attribution.approximation_error]
 is not populated.
 

repeated .google.cloud.aiplatform.v1.Attribution mean_attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getMeanAttributionsOrBuilder in interface ModelExplanationOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelExplanation parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ModelExplanation parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ModelExplanation.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ModelExplanation.Builder newBuilder()

newBuilder

public static ModelExplanation.Builder newBuilder(ModelExplanation prototype)

toBuilder

public ModelExplanation.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ModelExplanation getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder