Class ModelEvaluation (3.11.0)

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.v1beta1.ModelEvaluation

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

EXPLANATION_SPECS_FIELD_NUMBER

public static final int EXPLANATION_SPECS_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_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_DIMENSIONS_FIELD_NUMBER

public static final int SLICE_DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ModelEvaluation getDefaultInstance()
Returns
TypeDescription
ModelEvaluation

getDescriptor()

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

newBuilder()

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

newBuilder(ModelEvaluation prototype)

public static ModelEvaluation.Builder newBuilder(ModelEvaluation prototype)
Parameter
NameDescription
prototypeModelEvaluation
Returns
TypeDescription
ModelEvaluation.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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

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

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

getDefaultInstanceForType()

public ModelEvaluation getDefaultInstanceForType()
Returns
TypeDescription
ModelEvaluation

getDisplayName()

public String getDisplayName()

The display name of the ModelEvaluation.

string display_name = 10;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the ModelEvaluation.

string display_name = 10;

Returns
TypeDescription
ByteString

The bytes for displayName.

getExplanationSpecs(int index)

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.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
ModelEvaluation.ModelEvaluationExplanationSpec

getExplanationSpecsCount()

public int getExplanationSpecsCount()

Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data.

repeated .google.cloud.aiplatform.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

Returns
TypeDescription
int

getExplanationSpecsList()

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.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

Returns
TypeDescription
List<ModelEvaluationExplanationSpec>

getExplanationSpecsOrBuilder(int index)

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.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder

getExplanationSpecsOrBuilderList()

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.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpecOrBuilder>

getMetadata()

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;

Returns
TypeDescription
Value

The metadata.

getMetadataOrBuilder()

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;

Returns
TypeDescription
ValueOrBuilder

getMetrics()

public Value getMetrics()

Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3;

Returns
TypeDescription
Value

The metrics.

getMetricsOrBuilder()

public ValueOrBuilder getMetricsOrBuilder()

Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3;

Returns
TypeDescription
ValueOrBuilder

getMetricsSchemaUri()

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;

Returns
TypeDescription
String

The metricsSchemaUri.

getMetricsSchemaUriBytes()

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;

Returns
TypeDescription
ByteString

The bytes for metricsSchemaUri.

getModelExplanation()

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.v1beta1.ModelExplanation model_explanation = 8;

Returns
TypeDescription
ModelExplanation

The modelExplanation.

getModelExplanationOrBuilder()

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.v1beta1.ModelExplanation model_explanation = 8;

Returns
TypeDescription
ModelExplanationOrBuilder

getName()

public String getName()

Output only. The resource name of the ModelEvaluation.

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

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSliceDimensions(int index)

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;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The sliceDimensions at the given index.

getSliceDimensionsBytes(int 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;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the sliceDimensions at the given index.

getSliceDimensionsCount()

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;

Returns
TypeDescription
int

The count of sliceDimensions.

getSliceDimensionsList()

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;

Returns
TypeDescription
ProtocolStringList

A list containing the sliceDimensions.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
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
TypeDescription
boolean

Whether the createTime field is set.

hasMetadata()

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;

Returns
TypeDescription
boolean

Whether the metadata field is set.

hasMetrics()

public boolean hasMetrics()

Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri

.google.protobuf.Value metrics = 3;

Returns
TypeDescription
boolean

Whether the metrics field is set.

hasModelExplanation()

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.v1beta1.ModelExplanation model_explanation = 8;

Returns
TypeDescription
boolean

Whether the modelExplanation 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 ModelEvaluation.Builder newBuilderForType()
Returns
TypeDescription
ModelEvaluation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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