Package com.google.cloud.aiplatform.v1

Class ModelEvaluationSlice

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

    • 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 ModelEvaluationSlice.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ModelEvaluationSliceOrBuilder
        Returns:
        The name.

      • getNameBytes

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

      • hasSlice

        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];
        Specified by:
        hasSlice in interface ModelEvaluationSliceOrBuilder
        Returns:
        Whether the slice field is set.

      • getSlice

        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];
        Specified by:
        getSlice in interface ModelEvaluationSliceOrBuilder
        Returns:
        The slice.

      • getMetricsSchemaUri

        public String getMetricsSchemaUri()
         Output only. Points to a YAML file stored on Google Cloud Storage
 describing the
 [metrics][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics] of this
 ModelEvaluationSlice. 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 = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetricsSchemaUri in interface ModelEvaluationSliceOrBuilder
        Returns:
        The metricsSchemaUri.

      • getMetricsSchemaUriBytes

        public com.google.protobuf.ByteString getMetricsSchemaUriBytes()
         Output only. Points to a YAML file stored on Google Cloud Storage
 describing the
 [metrics][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics] of this
 ModelEvaluationSlice. 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 = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetricsSchemaUriBytes in interface ModelEvaluationSliceOrBuilder
        Returns:
        The bytes for metricsSchemaUri.

      • hasMetrics

        public boolean hasMetrics()
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasMetrics in interface ModelEvaluationSliceOrBuilder
        Returns:
        Whether the metrics field is set.

      • getMetrics

        public com.google.protobuf.Value getMetrics()
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetrics in interface ModelEvaluationSliceOrBuilder
        Returns:
        The metrics.

      • getMetricsOrBuilder

        public com.google.protobuf.ValueOrBuilder getMetricsOrBuilder()
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetricsOrBuilder in interface ModelEvaluationSliceOrBuilder

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

      • 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.v1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasModelExplanation in interface ModelEvaluationSliceOrBuilder
        Returns:
        Whether the modelExplanation field is set.

      • 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.v1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getModelExplanation in interface ModelEvaluationSliceOrBuilder
        Returns:
        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.v1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getModelExplanationOrBuilder in interface ModelEvaluationSliceOrBuilder

      • 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 ModelEvaluationSlice parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ModelEvaluationSlice> 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 ModelEvaluationSlice getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder