Package com.google.cloud.aiplatform.v1
Class Attribution
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Attribution
- All Implemented Interfaces:
AttributionOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class Attribution
extends com.google.protobuf.GeneratedMessage
implements AttributionOrBuilder
Attribution that explains a particular prediction output.Protobuf type
google.cloud.aiplatform.v1.Attribution- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classAttribution that explains a particular prediction output.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleandoubleOutput only.doubleOutput only.static Attributionstatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.ValueOutput only.com.google.protobuf.ValueOrBuilderOutput only.doubleOutput only.Output only.com.google.protobuf.ByteStringOutput only.intgetOutputIndex(int index) Output only.intOutput only.Output only.Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.Parser<Attribution>intbooleanOutput only.inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic Attribution.Builderstatic Attribution.BuildernewBuilder(Attribution prototype) protected Attribution.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static AttributionparseDelimitedFrom(InputStream input) static AttributionparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AttributionparseFrom(byte[] data) static AttributionparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AttributionparseFrom(com.google.protobuf.ByteString data) static AttributionparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AttributionparseFrom(com.google.protobuf.CodedInputStream input) static AttributionparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AttributionparseFrom(InputStream input) static AttributionparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AttributionparseFrom(ByteBuffer data) static AttributionparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Attribution>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
BASELINE_OUTPUT_VALUE_FIELD_NUMBER
public static final int BASELINE_OUTPUT_VALUE_FIELD_NUMBER- See Also:
-
INSTANCE_OUTPUT_VALUE_FIELD_NUMBER
public static final int INSTANCE_OUTPUT_VALUE_FIELD_NUMBER- See Also:
-
FEATURE_ATTRIBUTIONS_FIELD_NUMBER
public static final int FEATURE_ATTRIBUTIONS_FIELD_NUMBER- See Also:
-
OUTPUT_INDEX_FIELD_NUMBER
public static final int OUTPUT_INDEX_FIELD_NUMBER- See Also:
-
OUTPUT_DISPLAY_NAME_FIELD_NUMBER
public static final int OUTPUT_DISPLAY_NAME_FIELD_NUMBER- See Also:
-
APPROXIMATION_ERROR_FIELD_NUMBER
public static final int APPROXIMATION_ERROR_FIELD_NUMBER- See Also:
-
OUTPUT_NAME_FIELD_NUMBER
public static final int OUTPUT_NAME_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getBaselineOutputValue
public double getBaselineOutputValue()Output only. Model predicted output if the input instance is constructed from the baselines of all the features defined in [ExplanationMetadata.inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The field name of the output is determined by the key in [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs]. If the Model's predicted output has multiple dimensions (rank > 1), this is the value in the output located by [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. If there are multiple baselines, their output values are averaged.
double baseline_output_value = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getBaselineOutputValuein interfaceAttributionOrBuilder- Returns:
- The baselineOutputValue.
-
getInstanceOutputValue
public double getInstanceOutputValue()Output only. Model predicted output on the corresponding [explanation instance][ExplainRequest.instances]. The field name of the output is determined by the key in [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs]. If the Model predicted output has multiple dimensions, this is the value in the output located by [output_index][google.cloud.aiplatform.v1.Attribution.output_index].
double instance_output_value = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getInstanceOutputValuein interfaceAttributionOrBuilder- Returns:
- The instanceOutputValue.
-
hasFeatureAttributions
public boolean hasFeatureAttributions()Output only. Attributions of each explained feature. Features are extracted from the [prediction instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according to [explanation metadata for inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The value is a struct, whose keys are the name of the feature. The values are how much the feature in the [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed to the predicted result. The format of the value is determined by the feature's input format: * If the feature is a scalar value, the attribution value is a [floating number][google.protobuf.Value.number_value]. * If the feature is an array of scalar values, the attribution value is an [array][google.protobuf.Value.list_value]. * If the feature is a struct, the attribution value is a [struct][google.protobuf.Value.struct_value]. The keys in the attribution value struct are the same as the keys in the feature struct. The formats of the values in the attribution struct are determined by the formats of the values in the feature struct. The [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri] field, pointed to by the [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] object, points to the schema file that describes the features and their attribution values (if it is populated).
.google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasFeatureAttributionsin interfaceAttributionOrBuilder- Returns:
- Whether the featureAttributions field is set.
-
getFeatureAttributions
public com.google.protobuf.Value getFeatureAttributions()Output only. Attributions of each explained feature. Features are extracted from the [prediction instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according to [explanation metadata for inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The value is a struct, whose keys are the name of the feature. The values are how much the feature in the [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed to the predicted result. The format of the value is determined by the feature's input format: * If the feature is a scalar value, the attribution value is a [floating number][google.protobuf.Value.number_value]. * If the feature is an array of scalar values, the attribution value is an [array][google.protobuf.Value.list_value]. * If the feature is a struct, the attribution value is a [struct][google.protobuf.Value.struct_value]. The keys in the attribution value struct are the same as the keys in the feature struct. The formats of the values in the attribution struct are determined by the formats of the values in the feature struct. The [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri] field, pointed to by the [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] object, points to the schema file that describes the features and their attribution values (if it is populated).
.google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getFeatureAttributionsin interfaceAttributionOrBuilder- Returns:
- The featureAttributions.
-
getFeatureAttributionsOrBuilder
public com.google.protobuf.ValueOrBuilder getFeatureAttributionsOrBuilder()Output only. Attributions of each explained feature. Features are extracted from the [prediction instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according to [explanation metadata for inputs][google.cloud.aiplatform.v1.ExplanationMetadata.inputs]. The value is a struct, whose keys are the name of the feature. The values are how much the feature in the [instance][google.cloud.aiplatform.v1.ExplainRequest.instances] contributed to the predicted result. The format of the value is determined by the feature's input format: * If the feature is a scalar value, the attribution value is a [floating number][google.protobuf.Value.number_value]. * If the feature is an array of scalar values, the attribution value is an [array][google.protobuf.Value.list_value]. * If the feature is a struct, the attribution value is a [struct][google.protobuf.Value.struct_value]. The keys in the attribution value struct are the same as the keys in the feature struct. The formats of the values in the attribution struct are determined by the formats of the values in the feature struct. The [ExplanationMetadata.feature_attributions_schema_uri][google.cloud.aiplatform.v1.ExplanationMetadata.feature_attributions_schema_uri] field, pointed to by the [ExplanationSpec][google.cloud.aiplatform.v1.ExplanationSpec] field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] object, points to the schema file that describes the features and their attribution values (if it is populated).
.google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getFeatureAttributionsOrBuilderin interfaceAttributionOrBuilder
-
getOutputIndexList
Output only. The index that locates the explained prediction output. If the prediction output is a scalar value, output_index is not populated. If the prediction output has multiple dimensions, the length of the output_index list is the same as the number of dimensions of the output. The i-th element in output_index is the element index of the i-th dimension of the output vector. Indices start from 0.
repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getOutputIndexListin interfaceAttributionOrBuilder- Returns:
- A list containing the outputIndex.
-
getOutputIndexCount
public int getOutputIndexCount()Output only. The index that locates the explained prediction output. If the prediction output is a scalar value, output_index is not populated. If the prediction output has multiple dimensions, the length of the output_index list is the same as the number of dimensions of the output. The i-th element in output_index is the element index of the i-th dimension of the output vector. Indices start from 0.
repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getOutputIndexCountin interfaceAttributionOrBuilder- Returns:
- The count of outputIndex.
-
getOutputIndex
public int getOutputIndex(int index) Output only. The index that locates the explained prediction output. If the prediction output is a scalar value, output_index is not populated. If the prediction output has multiple dimensions, the length of the output_index list is the same as the number of dimensions of the output. The i-th element in output_index is the element index of the i-th dimension of the output vector. Indices start from 0.
repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getOutputIndexin interfaceAttributionOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The outputIndex at the given index.
-
getOutputDisplayName
Output only. The display name of the output identified by [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For example, the predicted class name by a multi-classification Model. This field is only populated iff the Model predicts display names as a separate field along with the explained output. The predicted display name must has the same shape of the explained output, and can be located using output_index.
string output_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getOutputDisplayNamein interfaceAttributionOrBuilder- Returns:
- The outputDisplayName.
-
getOutputDisplayNameBytes
public com.google.protobuf.ByteString getOutputDisplayNameBytes()Output only. The display name of the output identified by [output_index][google.cloud.aiplatform.v1.Attribution.output_index]. For example, the predicted class name by a multi-classification Model. This field is only populated iff the Model predicts display names as a separate field along with the explained output. The predicted display name must has the same shape of the explained output, and can be located using output_index.
string output_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getOutputDisplayNameBytesin interfaceAttributionOrBuilder- Returns:
- The bytes for outputDisplayName.
-
getApproximationError
public double getApproximationError()Output only. Error of [feature_attributions][google.cloud.aiplatform.v1.Attribution.feature_attributions] caused by approximation used in the explanation method. Lower value means more precise attributions. * For Sampled Shapley [attribution][google.cloud.aiplatform.v1.ExplanationParameters.sampled_shapley_attribution], increasing [path_count][google.cloud.aiplatform.v1.SampledShapleyAttribution.path_count] might reduce the error. * For Integrated Gradients [attribution][google.cloud.aiplatform.v1.ExplanationParameters.integrated_gradients_attribution], increasing [step_count][google.cloud.aiplatform.v1.IntegratedGradientsAttribution.step_count] might reduce the error. * For [XRAI attribution][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution], increasing [step_count][google.cloud.aiplatform.v1.XraiAttribution.step_count] might reduce the error. See [this introduction](/vertex-ai/docs/explainable-ai/overview) for more information.
double approximation_error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getApproximationErrorin interfaceAttributionOrBuilder- Returns:
- The approximationError.
-
getOutputName
Output only. Name of the explain output. Specified as the key in [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
string output_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getOutputNamein interfaceAttributionOrBuilder- Returns:
- The outputName.
-
getOutputNameBytes
public com.google.protobuf.ByteString getOutputNameBytes()Output only. Name of the explain output. Specified as the key in [ExplanationMetadata.outputs][google.cloud.aiplatform.v1.ExplanationMetadata.outputs].
string output_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getOutputNameBytesin interfaceAttributionOrBuilder- Returns:
- The bytes for outputName.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Attribution parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Attribution parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Attribution parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Attribution parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Attribution parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Attribution parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Attribution parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Attribution parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Attribution parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Attribution.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-