publicfinalclass ExplanationextendsGeneratedMessageV3implementsExplanationOrBuilder
Explanation of a prediction (provided in
PredictResponse.predictions)
produced by the Model on a given
instance.
Protobuf type google.cloud.vertexai.v1beta1.Explanation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ATTRIBUTIONS_FIELD_NUMBER
publicstaticfinalintATTRIBUTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NEIGHBORS_FIELD_NUMBER
publicstaticfinalintNEIGHBORS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticExplanationgetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticExplanation.BuildernewBuilder()
newBuilder(Explanation prototype)
publicstaticExplanation.BuildernewBuilder(Explanationprototype)
publicstaticExplanationparseDelimitedFrom(InputStreaminput)
publicstaticExplanationparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticExplanationparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticExplanationparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticExplanationparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticExplanationparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticExplanationparseFrom(CodedInputStreaminput)
publicstaticExplanationparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticExplanationparseFrom(InputStreaminput)
publicstaticExplanationparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticExplanationparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticExplanationparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<Explanation>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAttributions(int index)
publicAttributiongetAttributions(intindex)
Output only. Feature attributions grouped by predicted 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
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.vertexai.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
getAttributionsCount()
publicintgetAttributionsCount()
Output only. Feature attributions grouped by predicted 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
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.vertexai.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
getAttributionsList()
publicList<Attribution>getAttributionsList()
Output only. Feature attributions grouped by predicted 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
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.vertexai.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAttributionsOrBuilder(int index)
publicAttributionOrBuildergetAttributionsOrBuilder(intindex)
Output only. Feature attributions grouped by predicted 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
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.vertexai.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
getAttributionsOrBuilderList()
publicList<?extendsAttributionOrBuilder>getAttributionsOrBuilderList()
Output only. Feature attributions grouped by predicted 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
can be used to identify which output this attribution is explaining.
If users set
ExplanationParameters.top_k,
the attributions are sorted by
instance_output_value in descending
order. If
ExplanationParameters.output_indices
is specified, the attributions are stored by
Attribution.output_index
in the same order as they appear in the output_indices.
repeated .google.cloud.vertexai.v1beta1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.vertexai.api.AttributionOrBuilder> |
getDefaultInstanceForType()
publicExplanationgetDefaultInstanceForType()
getNeighbors(int index)
publicNeighborgetNeighbors(intindex)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.vertexai.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
getNeighborsCount()
publicintgetNeighborsCount()
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.vertexai.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
getNeighborsList()
publicList<Neighbor>getNeighborsList()
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.vertexai.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNeighborsOrBuilder(int index)
publicNeighborOrBuildergetNeighborsOrBuilder(intindex)
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.vertexai.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
getNeighborsOrBuilderList()
publicList<?extendsNeighborOrBuilder>getNeighborsOrBuilderList()
Output only. List of the nearest neighbors for example-based explanations.
For models deployed with the examples explanations feature enabled, the
attributions field is empty and instead the neighbors field is populated.
repeated .google.cloud.vertexai.v1beta1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.vertexai.api.NeighborOrBuilder> |
getParserForType()
publicParser<Explanation>getParserForType()
Overrides
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicExplanation.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedExplanation.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicExplanation.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides