public final class Attribution extends com.google.protobuf.GeneratedMessageV3 implements AttributionOrBuilder
Attribution that explains a particular prediction output.Protobuf type
google.cloud.vertexai.v1.Attribution| Modifier and Type | Class and Description |
|---|---|
static class |
Attribution.Builder
Attribution that explains a particular prediction output.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
APPROXIMATION_ERROR_FIELD_NUMBER |
static int |
BASELINE_OUTPUT_VALUE_FIELD_NUMBER |
static int |
FEATURE_ATTRIBUTIONS_FIELD_NUMBER |
static int |
INSTANCE_OUTPUT_VALUE_FIELD_NUMBER |
static int |
OUTPUT_DISPLAY_NAME_FIELD_NUMBER |
static int |
OUTPUT_INDEX_FIELD_NUMBER |
static int |
OUTPUT_NAME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
double |
getApproximationError()
Output only.
|
double |
getBaselineOutputValue()
Output only.
|
static Attribution |
getDefaultInstance() |
Attribution |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Value |
getFeatureAttributions()
Output only.
|
com.google.protobuf.ValueOrBuilder |
getFeatureAttributionsOrBuilder()
Output only.
|
double |
getInstanceOutputValue()
Output only.
|
String |
getOutputDisplayName()
Output only.
|
com.google.protobuf.ByteString |
getOutputDisplayNameBytes()
Output only.
|
int |
getOutputIndex(int index)
Output only.
|
int |
getOutputIndexCount()
Output only.
|
List<Integer> |
getOutputIndexList()
Output only.
|
String |
getOutputName()
Output only.
|
com.google.protobuf.ByteString |
getOutputNameBytes()
Output only.
|
com.google.protobuf.Parser<Attribution> |
getParserForType() |
int |
getSerializedSize() |
boolean |
hasFeatureAttributions()
Output only.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Attribution.Builder |
newBuilder() |
static Attribution.Builder |
newBuilder(Attribution prototype) |
Attribution.Builder |
newBuilderForType() |
protected Attribution.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Attribution |
parseDelimitedFrom(InputStream input) |
static Attribution |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Attribution |
parseFrom(byte[] data) |
static Attribution |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Attribution |
parseFrom(ByteBuffer data) |
static Attribution |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Attribution |
parseFrom(com.google.protobuf.ByteString data) |
static Attribution |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Attribution |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Attribution |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Attribution |
parseFrom(InputStream input) |
static Attribution |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Attribution> |
parser() |
Attribution.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int BASELINE_OUTPUT_VALUE_FIELD_NUMBER
public static final int INSTANCE_OUTPUT_VALUE_FIELD_NUMBER
public static final int FEATURE_ATTRIBUTIONS_FIELD_NUMBER
public static final int OUTPUT_INDEX_FIELD_NUMBER
public static final int OUTPUT_DISPLAY_NAME_FIELD_NUMBER
public static final int APPROXIMATION_ERROR_FIELD_NUMBER
public static final int OUTPUT_NAME_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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];getBaselineOutputValue in interface AttributionOrBuilderpublic 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];getInstanceOutputValue in interface AttributionOrBuilderpublic 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];
hasFeatureAttributions in interface AttributionOrBuilderpublic 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];
getFeatureAttributions in interface AttributionOrBuilderpublic 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];
getFeatureAttributionsOrBuilder in interface AttributionOrBuilderpublic List<Integer> 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];getOutputIndexList in interface AttributionOrBuilderpublic 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];getOutputIndexCount in interface AttributionOrBuilderpublic 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];getOutputIndex in interface AttributionOrBuilderindex - The index of the element to return.public String 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];getOutputDisplayName in interface AttributionOrBuilderpublic 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];getOutputDisplayNameBytes in interface AttributionOrBuilderpublic 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];getApproximationError in interface AttributionOrBuilderpublic String 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];getOutputName in interface AttributionOrBuilderpublic 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];getOutputNameBytes in interface AttributionOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Attribution parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Attribution parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Attribution parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Attribution parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Attribution parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Attribution parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Attribution parseFrom(InputStream input) throws IOException
IOExceptionpublic static Attribution parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Attribution parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Attribution parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Attribution parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Attribution parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Attribution.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Attribution.Builder newBuilder()
public static Attribution.Builder newBuilder(Attribution prototype)
public Attribution.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Attribution.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Attribution getDefaultInstance()
public static com.google.protobuf.Parser<Attribution> parser()
public com.google.protobuf.Parser<Attribution> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Attribution getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.