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.v1.ModelEvaluationSlice
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int METRICS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int METRICS_SCHEMA_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int MODEL_EXPLANATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int SLICE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static ModelEvaluationSlice getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ModelEvaluationSlice.Builder newBuilder()
public static ModelEvaluationSlice.Builder newBuilder(ModelEvaluationSlice prototype)
public static ModelEvaluationSlice parseDelimitedFrom(InputStream input)
public static ModelEvaluationSlice parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ModelEvaluationSlice parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static ModelEvaluationSlice parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ModelEvaluationSlice parseFrom(ByteString data)
public static ModelEvaluationSlice parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ModelEvaluationSlice parseFrom(CodedInputStream input)
public static ModelEvaluationSlice parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ModelEvaluationSlice parseFrom(InputStream input)
public static ModelEvaluationSlice parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ModelEvaluationSlice parseFrom(ByteBuffer data)
public static ModelEvaluationSlice parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ModelEvaluationSlice> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this ModelEvaluationSlice was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModelEvaluationSlice getDefaultInstanceForType()
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.
|
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];
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.
|
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.
|
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.v1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Output only. The resource name of the ModelEvaluationSlice.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
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.
|
public Parser<ModelEvaluationSlice> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public ModelEvaluationSlice.Slice getSlice()
Output only. The slice of the test data that is used to evaluate the Model.
.google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModelEvaluationSlice.SliceOrBuilder getSliceOrBuilder()
Output only. The slice of the test data that is used to evaluate the Model.
.google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
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.
|
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.v1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the modelExplanation field is set.
|
public boolean hasSlice()
Output only. The slice of the test data that is used to evaluate the Model.
.google.cloud.aiplatform.v1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the slice field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ModelEvaluationSlice.Builder newBuilderForType()
protected ModelEvaluationSlice.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public ModelEvaluationSlice.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
