Class ModelEvaluationSlice (3.43.0)

public final class ModelEvaluationSlice extends GeneratedMessageV3 implements ModelEvaluationSliceOrBuilder

A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.

Protobuf type google.cloud.aiplatform.v1beta1.ModelEvaluationSlice

Static 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_FIELD_NUMBER

public static final int SLICE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ModelEvaluationSlice getDefaultInstance()
Returns
Type Description
ModelEvaluationSlice

getDescriptor()

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

newBuilder()

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

newBuilder(ModelEvaluationSlice prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 ModelEvaluationSlice was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this ModelEvaluationSlice was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ModelEvaluationSlice getDefaultInstanceForType()
Returns
Type Description
ModelEvaluationSlice

getMetrics()

public Value getMetrics()

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

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

Returns
Type Description
Value

The metrics.

getMetricsOrBuilder()

public ValueOrBuilder getMetricsOrBuilder()

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

.google.protobuf.Value metrics = 4 [(.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 ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 3 [(.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 ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 Schema Object.

string metrics_schema_uri = 3 [(.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 tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.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 tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelExplanationOrBuilder

getName()

public String getName()

Output only. The resource name of the ModelEvaluationSlice.

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 ModelEvaluationSlice.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSlice()

public ModelEvaluationSlice.Slice getSlice()

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.Slice

The slice.

getSliceOrBuilder()

public ModelEvaluationSlice.SliceOrBuilder getSliceOrBuilder()

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelEvaluationSlice.SliceOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this ModelEvaluationSlice was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasMetrics()

public boolean hasMetrics()

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

.google.protobuf.Value metrics = 4 [(.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 tabular Models.

.google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the modelExplanation field is set.

hasSlice()

public boolean hasSlice()

Output only. The slice of the test data that is used to evaluate the Model.

.google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the slice 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

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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