Class Evaluation (0.123.3) 

public final class Evaluation extends GeneratedMessageV3 implements EvaluationOrBuilder

Describes an evaluation between a machine learning model's predictions and ground truth labels. Created when an EvaluationJob runs successfully.

Protobuf type google.cloud.datalabeling.v1beta1.Evaluation

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Evaluation

Implements

EvaluationOrBuilder

Static Fields

ANNOTATION_TYPE_FIELD_NUMBER

public static final int ANNOTATION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

EVALUATED_ITEM_COUNT_FIELD_NUMBER

public static final int EVALUATED_ITEM_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

EVALUATION_JOB_RUN_TIME_FIELD_NUMBER

public static final int EVALUATION_JOB_RUN_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

EVALUATION_METRICS_FIELD_NUMBER

public static final int EVALUATION_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Evaluation getDefaultInstance()
Returns
TypeDescription
Evaluation

getDescriptor()

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

newBuilder()

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

newBuilder(Evaluation prototype)

public static Evaluation.Builder newBuilder(Evaluation prototype)
Parameter
NameDescription
prototypeEvaluation
Returns
TypeDescription
Evaluation.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotationType()

public AnnotationType getAnnotationType()

Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;

Returns
TypeDescription
AnnotationType

The annotationType.

getAnnotationTypeValue()

public int getAnnotationTypeValue()

Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for annotationType.

getConfig()

public EvaluationConfig getConfig()

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Returns
TypeDescription
EvaluationConfig

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;

Returns
TypeDescription
EvaluationConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()
Returns
TypeDescription
Evaluation

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;

Returns
TypeDescription
long

The evaluatedItemCount.

getEvaluationJobRunTime()

public Timestamp getEvaluationJobRunTime()

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Returns
TypeDescription
Timestamp

The evaluationJobRunTime.

getEvaluationJobRunTimeOrBuilder()

public TimestampOrBuilder getEvaluationJobRunTimeOrBuilder()

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getEvaluationMetrics()

public EvaluationMetrics getEvaluationMetrics()

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Returns
TypeDescription
EvaluationMetrics

The evaluationMetrics.

getEvaluationMetricsOrBuilder()

public EvaluationMetricsOrBuilder getEvaluationMetricsOrBuilder()

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Returns
TypeDescription
EvaluationMetricsOrBuilder

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;

Returns
TypeDescription
String

The name.

getNameBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasConfig()

public boolean hasConfig()

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Returns
TypeDescription
boolean

Whether the config field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
boolean

Whether the createTime field is set.

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;

Returns
TypeDescription
boolean

Whether the evaluationJobRunTime field is set.

hasEvaluationMetrics()

public boolean hasEvaluationMetrics()

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Returns
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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