Class Evaluation (0.134.0)

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

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANNOTATION_TYPE_FIELD_NUMBER

public static final int ANNOTATION_TYPE_FIELD_NUMBER

Field Value
Type	Description
`int`

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

EVALUATED_ITEM_COUNT_FIELD_NUMBER

public static final int EVALUATED_ITEM_COUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

EVALUATION_JOB_RUN_TIME_FIELD_NUMBER

public static final int EVALUATION_JOB_RUN_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

EVALUATION_METRICS_FIELD_NUMBER

public static final int EVALUATION_METRICS_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Evaluation getDefaultInstance()

Returns
Type	Description
`Evaluation`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Evaluation.Builder newBuilder()

Returns
Type	Description
`Evaluation.Builder`

newBuilder(Evaluation prototype)

public static Evaluation.Builder newBuilder(Evaluation prototype)

Parameter
Name	Description
`prototype`	`Evaluation`

Returns
Type	Description
`Evaluation.Builder`

parseDelimitedFrom(InputStream input)

public static Evaluation parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Evaluation parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Evaluation parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Evaluation parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Evaluation parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Evaluation parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Evaluation`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Evaluation> parser()

Returns
Type	Description
`Parser<Evaluation>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`EvaluationConfigOrBuilder`

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
Type	Description
`TimestampOrBuilder`

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`TimestampOrBuilder`

getEvaluationMetrics()

public EvaluationMetrics getEvaluationMetrics()

Output only. Metrics comparing predictions to ground truth labels.

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

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`ByteString`	The bytes for name.

getParserForType()

public Parser<Evaluation> getParserForType()

Returns
Type	Description
`Parser<Evaluation>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

hasConfig()

public boolean hasConfig()

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

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

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`boolean`	Whether the evaluationMetrics field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Evaluation.Builder newBuilderForType()

Returns
Type	Description
`Evaluation.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Evaluation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Evaluation.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Evaluation.Builder toBuilder()

Returns
Type	Description
`Evaluation.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`