Class ModelEvaluation.Builder (2.5.3)

public static final class ModelEvaluation.Builder extends GeneratedMessageV3.Builder<ModelEvaluation.Builder> implements ModelEvaluationOrBuilder

A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.

Protobuf type google.cloud.aiplatform.v1.ModelEvaluation

Methods

addAllSliceDimensions(Iterable<String> values)

public ModelEvaluation.Builder addAllSliceDimensions(Iterable<String> values)

Output only. All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The sliceDimensions to add.

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ModelEvaluation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ModelEvaluation.Builder
Overrides

addSliceDimensions(String value)

public ModelEvaluation.Builder addSliceDimensions(String value)

Output only. All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The sliceDimensions to add.

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

addSliceDimensionsBytes(ByteString value)

public ModelEvaluation.Builder addSliceDimensionsBytes(ByteString value)

Output only. All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the sliceDimensions to add.

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

build()

public ModelEvaluation build()
Returns
Type Description
ModelEvaluation

buildPartial()

public ModelEvaluation buildPartial()
Returns
Type Description
ModelEvaluation

clear()

public ModelEvaluation.Builder clear()
Returns
Type Description
ModelEvaluation.Builder
Overrides

clearCreateTime()

public ModelEvaluation.Builder clearCreateTime()

Output only. Timestamp when this ModelEvaluation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluation.Builder

clearField(Descriptors.FieldDescriptor field)

public ModelEvaluation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ModelEvaluation.Builder
Overrides

clearMetrics()

public ModelEvaluation.Builder clearMetrics()

Output only. Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluation.Builder

clearMetricsSchemaUri()

public ModelEvaluation.Builder clearMetricsSchemaUri()

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

clearModelExplanation()

public ModelEvaluation.Builder clearModelExplanation()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluation.Builder

clearName()

public ModelEvaluation.Builder clearName()

Output only. The resource name of the ModelEvaluation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ModelEvaluation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ModelEvaluation.Builder
Overrides

clearSliceDimensions()

public ModelEvaluation.Builder clearSliceDimensions()

Output only. All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

clone()

public ModelEvaluation.Builder clone()
Returns
Type Description
ModelEvaluation.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this ModelEvaluation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this ModelEvaluation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this ModelEvaluation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ModelEvaluation getDefaultInstanceForType()
Returns
Type Description
ModelEvaluation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMetrics()

public Value getMetrics()

Output only. Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Value

The metrics.

getMetricsBuilder()

public Value.Builder getMetricsBuilder()

Output only. Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getMetricsOrBuilder()

public ValueOrBuilder getMetricsOrBuilder()

Output only. Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ValueOrBuilder

getMetricsSchemaUri()

public String getMetricsSchemaUri()

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The metricsSchemaUri.

getMetricsSchemaUriBytes()

public ByteString getMetricsSchemaUriBytes()

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for metricsSchemaUri.

getModelExplanation()

public ModelExplanation getModelExplanation()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelExplanation

The modelExplanation.

getModelExplanationBuilder()

public ModelExplanation.Builder getModelExplanationBuilder()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelExplanation.Builder

getModelExplanationOrBuilder()

public ModelExplanationOrBuilder getModelExplanationOrBuilder()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelExplanationOrBuilder

getName()

public String getName()

Output only. The resource name of the ModelEvaluation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the ModelEvaluation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getSliceDimensions(int index)

public String getSliceDimensions(int index)

Output only. All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The sliceDimensions at the given index.

getSliceDimensionsBytes(int index)

public ByteString getSliceDimensionsBytes(int index)

Output only. All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the sliceDimensions at the given index.

getSliceDimensionsCount()

public int getSliceDimensionsCount()

Output only. All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of sliceDimensions.

getSliceDimensionsList()

public ProtocolStringList getSliceDimensionsList()

Output only. All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the sliceDimensions.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this ModelEvaluation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasMetrics()

public boolean hasMetrics()

Output only. Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the metrics field is set.

hasModelExplanation()

public boolean hasModelExplanation()

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the modelExplanation field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public ModelEvaluation.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this ModelEvaluation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ModelEvaluation.Builder

mergeFrom(ModelEvaluation other)

public ModelEvaluation.Builder mergeFrom(ModelEvaluation other)
Parameter
Name Description
other ModelEvaluation
Returns
Type Description
ModelEvaluation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ModelEvaluation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelEvaluation.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public ModelEvaluation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ModelEvaluation.Builder
Overrides

mergeMetrics(Value value)

public ModelEvaluation.Builder mergeMetrics(Value value)

Output only. Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Value
Returns
Type Description
ModelEvaluation.Builder

mergeModelExplanation(ModelExplanation value)

public ModelEvaluation.Builder mergeModelExplanation(ModelExplanation value)

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ModelExplanation
Returns
Type Description
ModelEvaluation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ModelEvaluation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ModelEvaluation.Builder
Overrides

setCreateTime(Timestamp value)

public ModelEvaluation.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this ModelEvaluation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ModelEvaluation.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ModelEvaluation.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this ModelEvaluation was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ModelEvaluation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ModelEvaluation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ModelEvaluation.Builder
Overrides

setMetrics(Value value)

public ModelEvaluation.Builder setMetrics(Value value)

Output only. Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Value
Returns
Type Description
ModelEvaluation.Builder

setMetrics(Value.Builder builderForValue)

public ModelEvaluation.Builder setMetrics(Value.Builder builderForValue)

Output only. Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ModelEvaluation.Builder

setMetricsSchemaUri(String value)

public ModelEvaluation.Builder setMetricsSchemaUri(String value)

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The metricsSchemaUri to set.

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

setMetricsSchemaUriBytes(ByteString value)

public ModelEvaluation.Builder setMetricsSchemaUriBytes(ByteString value)

Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for metricsSchemaUri to set.

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

setModelExplanation(ModelExplanation value)

public ModelEvaluation.Builder setModelExplanation(ModelExplanation value)

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ModelExplanation
Returns
Type Description
ModelEvaluation.Builder

setModelExplanation(ModelExplanation.Builder builderForValue)

public ModelEvaluation.Builder setModelExplanation(ModelExplanation.Builder builderForValue)

Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models.

.google.cloud.aiplatform.v1.ModelExplanation model_explanation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ModelExplanation.Builder
Returns
Type Description
ModelEvaluation.Builder

setName(String value)

public ModelEvaluation.Builder setName(String value)

Output only. The resource name of the ModelEvaluation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ModelEvaluation.Builder setNameBytes(ByteString value)

Output only. The resource name of the ModelEvaluation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

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

public ModelEvaluation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ModelEvaluation.Builder
Overrides

setSliceDimensions(int index, String value)

public ModelEvaluation.Builder setSliceDimensions(int index, String value)

Output only. All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of slice.dimension = <dimension>.

repeated string slice_dimensions = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.

value String

The sliceDimensions to set.

Returns
Type Description
ModelEvaluation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ModelEvaluation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ModelEvaluation.Builder
Overrides