Class ModelExplanation.Builder (3.22.0)

public static final class ModelExplanation.Builder extends GeneratedMessageV3.Builder<ModelExplanation.Builder> implements ModelExplanationOrBuilder

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

Protobuf type google.cloud.aiplatform.v1beta1.ModelExplanation

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllMeanAttributions(Iterable<? extends Attribution> values)

public ModelExplanation.Builder addAllMeanAttributions(Iterable<? extends Attribution> values)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1beta1.Attribution>
Returns
TypeDescription
ModelExplanation.Builder

addMeanAttributions(Attribution value)

public ModelExplanation.Builder addMeanAttributions(Attribution value)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameter
NameDescription
valueAttribution
Returns
TypeDescription
ModelExplanation.Builder

addMeanAttributions(Attribution.Builder builderForValue)

public ModelExplanation.Builder addMeanAttributions(Attribution.Builder builderForValue)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameter
NameDescription
builderForValueAttribution.Builder
Returns
TypeDescription
ModelExplanation.Builder

addMeanAttributions(int index, Attribution value)

public ModelExplanation.Builder addMeanAttributions(int index, Attribution value)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameters
NameDescription
indexint
valueAttribution
Returns
TypeDescription
ModelExplanation.Builder

addMeanAttributions(int index, Attribution.Builder builderForValue)

public ModelExplanation.Builder addMeanAttributions(int index, Attribution.Builder builderForValue)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameters
NameDescription
indexint
builderForValueAttribution.Builder
Returns
TypeDescription
ModelExplanation.Builder

addMeanAttributionsBuilder()

public Attribution.Builder addMeanAttributionsBuilder()

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Returns
TypeDescription
Attribution.Builder

addMeanAttributionsBuilder(int index)

public Attribution.Builder addMeanAttributionsBuilder(int index)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Attribution.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ModelExplanation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ModelExplanation.Builder
Overrides

build()

public ModelExplanation build()
Returns
TypeDescription
ModelExplanation

buildPartial()

public ModelExplanation buildPartial()
Returns
TypeDescription
ModelExplanation

clear()

public ModelExplanation.Builder clear()
Returns
TypeDescription
ModelExplanation.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ModelExplanation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ModelExplanation.Builder
Overrides

clearMeanAttributions()

public ModelExplanation.Builder clearMeanAttributions()

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Returns
TypeDescription
ModelExplanation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ModelExplanation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ModelExplanation.Builder
Overrides

clone()

public ModelExplanation.Builder clone()
Returns
TypeDescription
ModelExplanation.Builder
Overrides

getDefaultInstanceForType()

public ModelExplanation getDefaultInstanceForType()
Returns
TypeDescription
ModelExplanation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMeanAttributions(int index)

public Attribution getMeanAttributions(int index)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Attribution

getMeanAttributionsBuilder(int index)

public Attribution.Builder getMeanAttributionsBuilder(int index)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Attribution.Builder

getMeanAttributionsBuilderList()

public List<Attribution.Builder> getMeanAttributionsBuilderList()

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Returns
TypeDescription
List<Builder>

getMeanAttributionsCount()

public int getMeanAttributionsCount()

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Returns
TypeDescription
int

getMeanAttributionsList()

public List<Attribution> getMeanAttributionsList()

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Returns
TypeDescription
List<Attribution>

getMeanAttributionsOrBuilder(int index)

public AttributionOrBuilder getMeanAttributionsOrBuilder(int index)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
AttributionOrBuilder

getMeanAttributionsOrBuilderList()

public List<? extends AttributionOrBuilder> getMeanAttributionsOrBuilderList()

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.AttributionOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ModelExplanation other)

public ModelExplanation.Builder mergeFrom(ModelExplanation other)
Parameter
NameDescription
otherModelExplanation
Returns
TypeDescription
ModelExplanation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ModelExplanation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelExplanation.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ModelExplanation.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ModelExplanation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ModelExplanation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ModelExplanation.Builder
Overrides

removeMeanAttributions(int index)

public ModelExplanation.Builder removeMeanAttributions(int index)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ModelExplanation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ModelExplanation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ModelExplanation.Builder
Overrides

setMeanAttributions(int index, Attribution value)

public ModelExplanation.Builder setMeanAttributions(int index, Attribution value)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameters
NameDescription
indexint
valueAttribution
Returns
TypeDescription
ModelExplanation.Builder

setMeanAttributions(int index, Attribution.Builder builderForValue)

public ModelExplanation.Builder setMeanAttributions(int index, Attribution.Builder builderForValue)

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

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

The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data.

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

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

Parameters
NameDescription
indexint
builderForValueAttribution.Builder
Returns
TypeDescription
ModelExplanation.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ModelExplanation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ModelExplanation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ModelExplanation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ModelExplanation.Builder
Overrides