Package com.google.cloud.datalabeling.v1beta1

Class Evaluation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datalabeling.v1beta1.Evaluation
All Implemented Interfaces:
EvaluationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Evaluation extends com.google.protobuf.GeneratedMessage implements EvaluationOrBuilder
 Describes an evaluation between a machine learning model's predictions and
 ground truth labels. Created when an [EvaluationJob][google.cloud.datalabeling.v1beta1.EvaluationJob] runs successfully.
Protobuf type google.cloud.datalabeling.v1beta1.Evaluation
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • CONFIG_FIELD_NUMBER

      public static final int CONFIG_FIELD_NUMBER
      See Also:

    • EVALUATION_JOB_RUN_TIME_FIELD_NUMBER

      public static final int EVALUATION_JOB_RUN_TIME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • EVALUATION_METRICS_FIELD_NUMBER

      public static final int EVALUATION_METRICS_FIELD_NUMBER
      See Also:

    • ANNOTATION_TYPE_FIELD_NUMBER

      public static final int ANNOTATION_TYPE_FIELD_NUMBER
      See Also:

    • EVALUATED_ITEM_COUNT_FIELD_NUMBER

      public static final int EVALUATED_ITEM_COUNT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Output only. Resource name of an evaluation. The name has the following
 format:

 "projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id</var>}'
      string name = 1;
      Specified by:
      getName in interface EvaluationOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Resource name of an evaluation. The name has the following
 format:

 "projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id</var>}'
      string name = 1;
      Specified by:
      getNameBytes in interface EvaluationOrBuilder
      Returns:
      The bytes for name.

    • hasConfig

      public boolean hasConfig()
       Output only. Options used in the evaluation job that created this
 evaluation.
      .google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;
      Specified by:
      hasConfig in interface EvaluationOrBuilder
      Returns:
      Whether the config field is set.

    • getConfig

      public EvaluationConfig getConfig()
       Output only. Options used in the evaluation job that created this
 evaluation.
      .google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;
      Specified by:
      getConfig in interface EvaluationOrBuilder
      Returns:
      The config.

    • getConfigOrBuilder

      public EvaluationConfigOrBuilder getConfigOrBuilder()
       Output only. Options used in the evaluation job that created this
 evaluation.
      .google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;
      Specified by:
      getConfigOrBuilder in interface EvaluationOrBuilder

    • hasEvaluationJobRunTime

      public boolean hasEvaluationJobRunTime()
       Output only. Timestamp for when the evaluation job that created this
 evaluation ran.
      .google.protobuf.Timestamp evaluation_job_run_time = 3;
      Specified by:
      hasEvaluationJobRunTime in interface EvaluationOrBuilder
      Returns:
      Whether the evaluationJobRunTime field is set.

    • getEvaluationJobRunTime

      public com.google.protobuf.Timestamp getEvaluationJobRunTime()
       Output only. Timestamp for when the evaluation job that created this
 evaluation ran.
      .google.protobuf.Timestamp evaluation_job_run_time = 3;
      Specified by:
      getEvaluationJobRunTime in interface EvaluationOrBuilder
      Returns:
      The evaluationJobRunTime.

    • getEvaluationJobRunTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEvaluationJobRunTimeOrBuilder()
       Output only. Timestamp for when the evaluation job that created this
 evaluation ran.
      .google.protobuf.Timestamp evaluation_job_run_time = 3;
      Specified by:
      getEvaluationJobRunTimeOrBuilder in interface EvaluationOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp for when this evaluation was created.
      .google.protobuf.Timestamp create_time = 4;
      Specified by:
      hasCreateTime in interface EvaluationOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp for when this evaluation was created.
      .google.protobuf.Timestamp create_time = 4;
      Specified by:
      getCreateTime in interface EvaluationOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp for when this evaluation was created.
      .google.protobuf.Timestamp create_time = 4;
      Specified by:
      getCreateTimeOrBuilder in interface EvaluationOrBuilder

    • hasEvaluationMetrics

      public boolean hasEvaluationMetrics()
       Output only. Metrics comparing predictions to ground truth labels.
      .google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;
      Specified by:
      hasEvaluationMetrics in interface EvaluationOrBuilder
      Returns:
      Whether the evaluationMetrics field is set.

    • getEvaluationMetrics

      public EvaluationMetrics getEvaluationMetrics()
       Output only. Metrics comparing predictions to ground truth labels.
      .google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;
      Specified by:
      getEvaluationMetrics in interface EvaluationOrBuilder
      Returns:
      The evaluationMetrics.

    • getEvaluationMetricsOrBuilder

      public EvaluationMetricsOrBuilder getEvaluationMetricsOrBuilder()
       Output only. Metrics comparing predictions to ground truth labels.
      .google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;
      Specified by:
      getEvaluationMetricsOrBuilder in interface EvaluationOrBuilder

    • getAnnotationTypeValue

      public int getAnnotationTypeValue()
       Output only. Type of task that the model version being evaluated performs,
 as defined in the

 [evaluationJobConfig.inputConfig.annotationType][google.cloud.datalabeling.v1beta1.EvaluationJobConfig.input_config]
 field of the evaluation job that created this evaluation.
      .google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;
      Specified by:
      getAnnotationTypeValue in interface EvaluationOrBuilder
      Returns:
      The enum numeric value on the wire for annotationType.

    • getAnnotationType

      public AnnotationType getAnnotationType()
       Output only. Type of task that the model version being evaluated performs,
 as defined in the

 [evaluationJobConfig.inputConfig.annotationType][google.cloud.datalabeling.v1beta1.EvaluationJobConfig.input_config]
 field of the evaluation job that created this evaluation.
      .google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;
      Specified by:
      getAnnotationType in interface EvaluationOrBuilder
      Returns:
      The annotationType.

    • getEvaluatedItemCount

      public long getEvaluatedItemCount()
       Output only. The number of items in the ground truth dataset that were used
 for this evaluation. Only populated when the evaulation is for certain
 AnnotationTypes.
      int64 evaluated_item_count = 7;
      Specified by:
      getEvaluatedItemCount in interface EvaluationOrBuilder
      Returns:
      The evaluatedItemCount.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Evaluation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Evaluation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Evaluation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Evaluation.Builder newBuilder()

    • newBuilder

      public static Evaluation.Builder newBuilder(Evaluation prototype)

    • toBuilder

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

    • newBuilderForType

      protected Evaluation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Evaluation getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Evaluation> 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.GeneratedMessage

    • getDefaultInstanceForType

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