Class ModelEvaluation (2.5.3) 

public final class ModelEvaluation extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ModelEvaluation

Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

METRICS_SCHEMA_URI_FIELD_NUMBER

public static final int METRICS_SCHEMA_URI_FIELD_NUMBER
Field Value
Type Description
int

MODEL_EXPLANATION_FIELD_NUMBER

public static final int MODEL_EXPLANATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SLICE_DIMENSIONS_FIELD_NUMBER

public static final int SLICE_DIMENSIONS_FIELD_NUMBER
Field Value
Type Description
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

getDefaultInstance()

public static ModelEvaluation getDefaultInstance()
Returns
Type Description
ModelEvaluation

getDefaultInstanceForType()

public ModelEvaluation getDefaultInstanceForType()
Returns
Type Description
ModelEvaluation

getDescriptor()

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

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.

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.

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.

getParserForType()

public Parser<ModelEvaluation> getParserForType()
Returns
Type Description
Parser<ModelEvaluation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilder()

public static ModelEvaluation.Builder newBuilder()
Returns
Type Description
ModelEvaluation.Builder

newBuilder(ModelEvaluation prototype)

public static ModelEvaluation.Builder newBuilder(ModelEvaluation prototype)
Parameter
Name Description
prototype ModelEvaluation
Returns
Type Description
ModelEvaluation.Builder

newBuilderForType()

public ModelEvaluation.Builder newBuilderForType()
Returns
Type Description
ModelEvaluation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ModelEvaluation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ModelEvaluation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

parseDelimitedFrom(InputStream input)

public static ModelEvaluation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ModelEvaluation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ModelEvaluation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ModelEvaluation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ModelEvaluation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ModelEvaluation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ModelEvaluation> parser()
Returns
Type Description
Parser<ModelEvaluation>

toBuilder()

public ModelEvaluation.Builder toBuilder()
Returns
Type Description
ModelEvaluation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException