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
Static Fields
public static final int ANNOTATION_SCHEMA_URI_FIELD_NUMBER
Field Value
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int DATA_ITEM_SCHEMA_URI_FIELD_NUMBER
Field Value
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int EXPLANATION_SPECS_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
public static final int METRICS_FIELD_NUMBER
Field Value
public static final int METRICS_SCHEMA_URI_FIELD_NUMBER
Field Value
public static final int MODEL_EXPLANATION_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int SLICE_DIMENSIONS_FIELD_NUMBER
Field Value
Static Methods
public static ModelEvaluation getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ModelEvaluation.Builder newBuilder()
Returns
public static ModelEvaluation.Builder newBuilder(ModelEvaluation prototype)
Parameter
Returns
public static ModelEvaluation parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ModelEvaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelEvaluation parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static ModelEvaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelEvaluation parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ModelEvaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelEvaluation parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ModelEvaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelEvaluation parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ModelEvaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelEvaluation parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ModelEvaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ModelEvaluation> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public String getAnnotationSchemaUri()
Points to a YAML file stored on Google Cloud Storage describing
[EvaluatedDataItemView.predictions][],
[EvaluatedDataItemView.ground_truths][],
[EvaluatedAnnotation.predictions][], and
[EvaluatedAnnotation.ground_truths][]. The schema is defined as an
OpenAPI 3.0.2 Schema
Object.
This field is not populated if there are neither EvaluatedDataItemViews nor
EvaluatedAnnotations under this ModelEvaluation.
string annotation_schema_uri = 7;
| Type | Description |
| String | The annotationSchemaUri.
|
public ByteString getAnnotationSchemaUriBytes()
Points to a YAML file stored on Google Cloud Storage describing
[EvaluatedDataItemView.predictions][],
[EvaluatedDataItemView.ground_truths][],
[EvaluatedAnnotation.predictions][], and
[EvaluatedAnnotation.ground_truths][]. The schema is defined as an
OpenAPI 3.0.2 Schema
Object.
This field is not populated if there are neither EvaluatedDataItemViews nor
EvaluatedAnnotations under this ModelEvaluation.
string annotation_schema_uri = 7;
| Type | Description |
| ByteString | The bytes for annotationSchemaUri.
|
public Timestamp getCreateTime()
Output only. Timestamp when this ModelEvaluation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this ModelEvaluation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getDataItemSchemaUri()
Points to a YAML file stored on Google Cloud Storage describing
[EvaluatedDataItemView.data_item_payload][] and
[EvaluatedAnnotation.data_item_payload][]. The schema is defined as an
OpenAPI 3.0.2 Schema
Object.
This field is not populated if there are neither EvaluatedDataItemViews nor
EvaluatedAnnotations under this ModelEvaluation.
string data_item_schema_uri = 6;
| Type | Description |
| String | The dataItemSchemaUri.
|
public ByteString getDataItemSchemaUriBytes()
Points to a YAML file stored on Google Cloud Storage describing
[EvaluatedDataItemView.data_item_payload][] and
[EvaluatedAnnotation.data_item_payload][]. The schema is defined as an
OpenAPI 3.0.2 Schema
Object.
This field is not populated if there are neither EvaluatedDataItemViews nor
EvaluatedAnnotations under this ModelEvaluation.
string data_item_schema_uri = 6;
| Type | Description |
| ByteString | The bytes for dataItemSchemaUri.
|
public ModelEvaluation getDefaultInstanceForType()
Returns
public String getDisplayName()
The display name of the ModelEvaluation.
string display_name = 10;
| Type | Description |
| String | The displayName.
|
public ByteString getDisplayNameBytes()
The display name of the ModelEvaluation.
string display_name = 10;
| Type | Description |
| ByteString | The bytes for displayName.
|
public ModelEvaluation.ModelEvaluationExplanationSpec getExplanationSpecs(int index)
Describes the values of ExplanationSpec that are used for explaining
the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
public int getExplanationSpecsCount()
Describes the values of ExplanationSpec that are used for explaining
the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
public List<ModelEvaluation.ModelEvaluationExplanationSpec> getExplanationSpecsList()
Describes the values of ExplanationSpec that are used for explaining
the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
public ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder getExplanationSpecsOrBuilder(int index)
Describes the values of ExplanationSpec that are used for explaining
the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
public List<? extends ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder> getExplanationSpecsOrBuilderList()
Describes the values of ExplanationSpec that are used for explaining
the predicted values on the evaluated data.
repeated .google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
| Type | Description |
| List<? extends com.google.cloud.aiplatform.v1.ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder> | |
public Value getMetadata()
The metadata of the ModelEvaluation.
For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
"evaluation_dataset_path".
.google.protobuf.Value metadata = 11;
| Type | Description |
| Value | The metadata.
|
public ValueOrBuilder getMetadataOrBuilder()
The metadata of the ModelEvaluation.
For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
"evaluation_dataset_path".
.google.protobuf.Value metadata = 11;
public Value getMetrics()
Evaluation metrics of the Model. The schema of the metrics is stored in
metrics_schema_uri
.google.protobuf.Value metrics = 3;
| Type | Description |
| Value | The metrics.
|
public ValueOrBuilder getMetricsOrBuilder()
Evaluation metrics of the Model. The schema of the metrics is stored in
metrics_schema_uri
.google.protobuf.Value metrics = 3;
public String getMetricsSchemaUri()
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;
| Type | Description |
| String | The metricsSchemaUri.
|
public ByteString getMetricsSchemaUriBytes()
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;
| Type | Description |
| ByteString | The bytes for metricsSchemaUri.
|
public ModelExplanation getModelExplanation()
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;
public ModelExplanationOrBuilder getModelExplanationOrBuilder()
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;
Output only. The resource name of the ModelEvaluation.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Output only. The resource name of the ModelEvaluation.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Parser<ModelEvaluation> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public String getSliceDimensions(int index)
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;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The sliceDimensions at the given index.
|
public ByteString getSliceDimensionsBytes(int index)
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;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the sliceDimensions at the given index.
|
public int getSliceDimensionsCount()
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;
| Type | Description |
| int | The count of sliceDimensions.
|
public ProtocolStringList getSliceDimensionsList()
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;
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasCreateTime()
Output only. Timestamp when this ModelEvaluation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
public boolean hasMetadata()
The metadata of the ModelEvaluation.
For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a
structured value with keys of "pipeline_job_id", "evaluation_dataset_type",
"evaluation_dataset_path".
.google.protobuf.Value metadata = 11;
| Type | Description |
| boolean | Whether the metadata field is set.
|
public boolean hasMetrics()
Evaluation metrics of the Model. The schema of the metrics is stored in
metrics_schema_uri
.google.protobuf.Value metrics = 3;
| Type | Description |
| boolean | Whether the metrics field is set.
|
public boolean hasModelExplanation()
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;
| Type | Description |
| boolean | Whether the modelExplanation field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ModelEvaluation.Builder newBuilderForType()
Returns
protected ModelEvaluation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ModelEvaluation.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
