Class Explanation.Builder (1.40.0)
Stay organized with collections
Save and categorize content based on your preferences.
publicstaticfinalclass Explanation.BuilderextendsGeneratedMessageV3.Builder<Explanation.Builder>implementsExplanationOrBuilderExplanation of a prediction (provided in PredictResponse.predictions) produced by the Model on a given instance.
Protobuf type google.cloud.vertexai.v1.Explanation
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Explanation.BuilderImplements
ExplanationOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllAttributions(Iterable<? extends Attribution> values)
publicExplanation.BuilderaddAllAttributions(Iterable<?extendsAttribution>values)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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.vertexai.api.Attribution> |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addAllNeighbors(Iterable<? extends Neighbor> values)
publicExplanation.BuilderaddAllNeighbors(Iterable<?extendsNeighbor>values)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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.vertexai.api.Neighbor> |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addAttributions(Attribution value)
publicExplanation.BuilderaddAttributions(Attributionvalue)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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Attribution |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addAttributions(Attribution.Builder builderForValue)
publicExplanation.BuilderaddAttributions(Attribution.BuilderbuilderForValue)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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Attribution.Builder |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addAttributions(int index, Attribution value)
publicExplanation.BuilderaddAttributions(intindex,Attributionvalue)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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Attribution |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addAttributions(int index, Attribution.Builder builderForValue)
publicExplanation.BuilderaddAttributions(intindex,Attribution.BuilderbuilderForValue)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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Attribution.Builder |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addAttributionsBuilder()
publicAttribution.BuilderaddAttributionsBuilder()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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Attribution.Builder |
|
addAttributionsBuilder(int index)
publicAttribution.BuilderaddAttributionsBuilder(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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Attribution.Builder |
|
addNeighbors(Neighbor value)
publicExplanation.BuilderaddNeighbors(Neighborvalue)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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Neighbor |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addNeighbors(Neighbor.Builder builderForValue)
publicExplanation.BuilderaddNeighbors(Neighbor.BuilderbuilderForValue)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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Neighbor.Builder |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addNeighbors(int index, Neighbor value)
publicExplanation.BuilderaddNeighbors(intindex,Neighborvalue)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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Neighbor |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addNeighbors(int index, Neighbor.Builder builderForValue)
publicExplanation.BuilderaddNeighbors(intindex,Neighbor.BuilderbuilderForValue)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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Neighbor.Builder |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
addNeighborsBuilder()
publicNeighbor.BuilderaddNeighborsBuilder()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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Neighbor.Builder |
|
addNeighborsBuilder(int index)
publicNeighbor.BuilderaddNeighborsBuilder(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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Neighbor.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicExplanation.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
build()
publicExplanationbuild()| Returns | |
|---|---|
| Type | Description |
Explanation |
|
buildPartial()
publicExplanationbuildPartial()| Returns | |
|---|---|
| Type | Description |
Explanation |
|
clear()
publicExplanation.Builderclear()| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
clearAttributions()
publicExplanation.BuilderclearAttributions()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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
clearField(Descriptors.FieldDescriptor field)
publicExplanation.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
clearNeighbors()
publicExplanation.BuilderclearNeighbors()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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
publicExplanation.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
clone()
publicExplanation.Builderclone()| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Attribution |
|
getAttributionsBuilder(int index)
publicAttribution.BuildergetAttributionsBuilder(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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Attribution.Builder |
|
getAttributionsBuilderList()
publicList<Attribution.Builder>getAttributionsBuilderList()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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Attribution> |
|
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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AttributionOrBuilder |
|
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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.vertexai.api.AttributionOrBuilder> |
|
getDefaultInstanceForType()
publicExplanationgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Explanation |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Neighbor |
|
getNeighborsBuilder(int index)
publicNeighbor.BuildergetNeighborsBuilder(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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Neighbor.Builder |
|
getNeighborsBuilderList()
publicList<Neighbor.Builder>getNeighborsBuilderList()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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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.v1.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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Neighbor> |
|
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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
NeighborOrBuilder |
|
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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.vertexai.api.NeighborOrBuilder> |
|
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Explanation other)
publicExplanation.BuildermergeFrom(Explanationother)| Parameter | |
|---|---|
| Name | Description |
other |
Explanation |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicExplanation.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicExplanation.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalExplanation.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
removeAttributions(int index)
publicExplanation.BuilderremoveAttributions(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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
removeNeighbors(int index)
publicExplanation.BuilderremoveNeighbors(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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
setAttributions(int index, Attribution value)
publicExplanation.BuildersetAttributions(intindex,Attributionvalue)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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Attribution |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
setAttributions(int index, Attribution.Builder builderForValue)
publicExplanation.BuildersetAttributions(intindex,Attribution.BuilderbuilderForValue)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.
By default, we provide Shapley values for the predicted class. However,
you can configure the explanation request to generate Shapley values for
any other classes too. For example, if a model predicts a probability of
0.4 for approving a loan application, the model's decision is to reject
the application since p(reject) = 0.6 > p(approve) = 0.4, and the default
Shapley values would be computed for rejection decision and not approval,
even though the latter might be the positive class.
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.v1.Attribution attributions = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Attribution.Builder |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
publicExplanation.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
setNeighbors(int index, Neighbor value)
publicExplanation.BuildersetNeighbors(intindex,Neighborvalue)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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Neighbor |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
setNeighbors(int index, Neighbor.Builder builderForValue)
publicExplanation.BuildersetNeighbors(intindex,Neighbor.BuilderbuilderForValue)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.v1.Neighbor neighbors = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Neighbor.Builder |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicExplanation.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalExplanation.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Explanation.Builder |
|