Class ModelEvaluationSlice (3.31.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
TypeDescription
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

METRICS_SCHEMA_URI_FIELD_NUMBER

public static final int METRICS_SCHEMA_URI_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_EXPLANATION_FIELD_NUMBER

public static final int MODEL_EXPLANATION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SLICE_FIELD_NUMBER

public static final int SLICE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ModelEvaluationSlice getDefaultInstance()
Returns
TypeDescription
ModelEvaluationSlice

getDescriptor()

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

newBuilder()

public static ModelEvaluationSlice.Builder newBuilder()
Returns
TypeDescription
ModelEvaluationSlice.Builder

newBuilder(ModelEvaluationSlice prototype)

public static ModelEvaluationSlice.Builder newBuilder(ModelEvaluationSlice prototype)
Parameter
NameDescription
prototypeModelEvaluationSlice
Returns
TypeDescription
ModelEvaluationSlice.Builder

parseDelimitedFrom(InputStream input)

public static ModelEvaluationSlice parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluationSlice parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ModelEvaluationSlice parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluationSlice parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ModelEvaluationSlice parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluationSlice parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ModelEvaluationSlice parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluationSlice parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ModelEvaluationSlice parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluationSlice parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ModelEvaluationSlice parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ModelEvaluationSlice parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelEvaluationSlice
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ModelEvaluationSlice> parser()
Returns
TypeDescription
Parser<ModelEvaluationSlice>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ModelEvaluationSlice getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ModelExplanationOrBuilder

getName()

public String getName()

Output only. The resource name of the ModelEvaluationSlice.

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

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ModelEvaluationSlice> getParserForType()
Returns
TypeDescription
Parser<ModelEvaluationSlice>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the slice field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ModelEvaluationSlice.Builder newBuilderForType()
Returns
TypeDescription
ModelEvaluationSlice.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ModelEvaluationSlice.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ModelEvaluationSlice.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ModelEvaluationSlice.Builder toBuilder()
Returns
TypeDescription
ModelEvaluationSlice.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException