Package com.google.cloud.aiplatform.v1beta1

Class ModelEvaluation

  • All Implemented Interfaces:
    ModelEvaluationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ModelEvaluation
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • METRICS_SCHEMA_URI_FIELD_NUMBER

        public static final int METRICS_SCHEMA_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SLICE_DIMENSIONS_FIELD_NUMBER

        public static final int SLICE_DIMENSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MODEL_EXPLANATION_FIELD_NUMBER

        public static final int MODEL_EXPLANATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPLANATION_SPECS_FIELD_NUMBER

        public static final int EXPLANATION_SPECS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BIAS_CONFIGS_FIELD_NUMBER

        public static final int BIAS_CONFIGS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The resource name of the ModelEvaluation.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ModelEvaluationOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the ModelEvaluation.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ModelEvaluationOrBuilder
        Returns:
        The bytes for name.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The display name of the ModelEvaluation.
        string display_name = 10;
        Specified by:
        getDisplayNameBytes in interface ModelEvaluationOrBuilder
        Returns:
        The bytes for displayName.

      • getMetricsSchemaUri

        public String getMetricsSchemaUri()
         Points to a YAML file stored on Google Cloud Storage describing the
 [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics] of this
 ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
        string metrics_schema_uri = 2;
        Specified by:
        getMetricsSchemaUri in interface ModelEvaluationOrBuilder
        Returns:
        The metricsSchemaUri.

      • getMetricsSchemaUriBytes

        public com.google.protobuf.ByteString getMetricsSchemaUriBytes()
         Points to a YAML file stored on Google Cloud Storage describing the
 [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics] of this
 ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
        string metrics_schema_uri = 2;
        Specified by:
        getMetricsSchemaUriBytes in interface ModelEvaluationOrBuilder
        Returns:
        The bytes for metricsSchemaUri.

      • hasMetrics

        public boolean hasMetrics()
         Evaluation metrics of the Model. The schema of the metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics_schema_uri]
        .google.protobuf.Value metrics = 3;
        Specified by:
        hasMetrics in interface ModelEvaluationOrBuilder
        Returns:
        Whether the metrics field is set.

      • getMetrics

        public com.google.protobuf.Value getMetrics()
         Evaluation metrics of the Model. The schema of the metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics_schema_uri]
        .google.protobuf.Value metrics = 3;
        Specified by:
        getMetrics in interface ModelEvaluationOrBuilder
        Returns:
        The metrics.

      • getMetricsOrBuilder

        public com.google.protobuf.ValueOrBuilder getMetricsOrBuilder()
         Evaluation metrics of the Model. The schema of the metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluation.metrics_schema_uri]
        .google.protobuf.Value metrics = 3;
        Specified by:
        getMetricsOrBuilder in interface ModelEvaluationOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this ModelEvaluation was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ModelEvaluationOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this ModelEvaluation was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ModelEvaluationOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this ModelEvaluation was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ModelEvaluationOrBuilder

      • getSliceDimensionsList

        public com.google.protobuf.ProtocolStringList getSliceDimensionsList()
         All possible
 [dimensions][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice.dimension]
 of ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]
 request, in the form of `slice.dimension = <dimension>`.
        repeated string slice_dimensions = 5;
        Specified by:
        getSliceDimensionsList in interface ModelEvaluationOrBuilder
        Returns:
        A list containing the sliceDimensions.

      • getSliceDimensionsCount

        public int getSliceDimensionsCount()
         All possible
 [dimensions][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice.dimension]
 of ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]
 request, in the form of `slice.dimension = <dimension>`.
        repeated string slice_dimensions = 5;
        Specified by:
        getSliceDimensionsCount in interface ModelEvaluationOrBuilder
        Returns:
        The count of sliceDimensions.

      • getSliceDimensions

        public String getSliceDimensions​(int index)
         All possible
 [dimensions][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice.dimension]
 of ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]
 request, in the form of `slice.dimension = <dimension>`.
        repeated string slice_dimensions = 5;
        Specified by:
        getSliceDimensions in interface ModelEvaluationOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The sliceDimensions at the given index.

      • getSliceDimensionsBytes

        public com.google.protobuf.ByteString getSliceDimensionsBytes​(int index)
         All possible
 [dimensions][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice.dimension]
 of ModelEvaluationSlices. The dimensions can be used as the filter of the
 [ModelService.ListModelEvaluationSlices][google.cloud.aiplatform.v1beta1.ModelService.ListModelEvaluationSlices]
 request, in the form of `slice.dimension = <dimension>`.
        repeated string slice_dimensions = 5;
        Specified by:
        getSliceDimensionsBytes in interface ModelEvaluationOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the sliceDimensions at the given index.

      • 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;
        Specified by:
        hasModelExplanation in interface ModelEvaluationOrBuilder
        Returns:
        Whether the modelExplanation field is set.

      • 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;
        Specified by:
        getModelExplanation in interface ModelEvaluationOrBuilder
        Returns:
        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;
        Specified by:
        getModelExplanationOrBuilder in interface ModelEvaluationOrBuilder

      • getExplanationSpecsCount

        public int getExplanationSpecsCount()
         Describes the values of
 [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are
 used for explaining the predicted values on the evaluated data.
        repeated .google.cloud.aiplatform.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
        Specified by:
        getExplanationSpecsCount in interface ModelEvaluationOrBuilder

      • getExplanationSpecs

        public ModelEvaluation.ModelEvaluationExplanationSpec getExplanationSpecs​(int index)
         Describes the values of
 [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] that are
 used for explaining the predicted values on the evaluated data.
        repeated .google.cloud.aiplatform.v1beta1.ModelEvaluation.ModelEvaluationExplanationSpec explanation_specs = 9;
        Specified by:
        getExplanationSpecs in interface ModelEvaluationOrBuilder

      • 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;
        Specified by:
        hasMetadata in interface ModelEvaluationOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public com.google.protobuf.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;
        Specified by:
        getMetadata in interface ModelEvaluationOrBuilder
        Returns:
        The metadata.

      • getMetadataOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getMetadataOrBuilder in interface ModelEvaluationOrBuilder

      • hasBiasConfigs

        public boolean hasBiasConfigs()
         Specify the configuration for bias detection.
        .google.cloud.aiplatform.v1beta1.ModelEvaluation.BiasConfig bias_configs = 12;
        Specified by:
        hasBiasConfigs in interface ModelEvaluationOrBuilder
        Returns:
        Whether the biasConfigs field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ModelEvaluation parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelEvaluation parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ModelEvaluation.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ModelEvaluation.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ModelEvaluation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<ModelEvaluation> parser()

      • getParserForType

        public com.google.protobuf.Parser<ModelEvaluation> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ModelEvaluation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder