Class Metric (3.59.0)

Version latest

• 3.59.0 (latest)
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public final class Metric extends GeneratedMessageV3 implements MetricOrBuilder

The metric used for dataset level evaluation.

Protobuf type google.cloud.aiplatform.v1beta1.Metric

Inheritance

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

Implements

MetricOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

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)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

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)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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

AGGREGATION_METRICS_FIELD_NUMBER

public static final int AGGREGATION_METRICS_FIELD_NUMBER

Field Value
Type	Description
int

BLEU_SPEC_FIELD_NUMBER

public static final int BLEU_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

EXACT_MATCH_SPEC_FIELD_NUMBER

public static final int EXACT_MATCH_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

PAIRWISE_METRIC_SPEC_FIELD_NUMBER

public static final int PAIRWISE_METRIC_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

POINTWISE_METRIC_SPEC_FIELD_NUMBER

public static final int POINTWISE_METRIC_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

ROUGE_SPEC_FIELD_NUMBER

public static final int ROUGE_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Metric getDefaultInstance()

Returns
Type	Description
Metric

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Metric.Builder newBuilder()

Returns
Type	Description
Metric.Builder

newBuilder(Metric prototype)

public static Metric.Builder newBuilder(Metric prototype)

Parameter
Name	Description
prototype	Metric

Returns
Type	Description
Metric.Builder

parseDelimitedFrom(InputStream input)

public static Metric parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Metric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Metric parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Metric parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Metric parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Metric parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Metric parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Metric

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Metric> parser()

Returns
Type	Description
Parser<Metric>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAggregationMetrics(int index)

public Metric.AggregationMetric getAggregationMetrics(int index)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
Metric.AggregationMetric	The aggregationMetrics at the given index.

getAggregationMetricsCount()

public int getAggregationMetricsCount()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of aggregationMetrics.

getAggregationMetricsList()

public List<Metric.AggregationMetric> getAggregationMetricsList()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<AggregationMetric>	A list containing the aggregationMetrics.

getAggregationMetricsValue(int index)

public int getAggregationMetricsValue(int index)

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of aggregationMetrics at the given index.

getAggregationMetricsValueList()

public List<Integer> getAggregationMetricsValueList()

Optional. The aggregation metrics to use.

repeated .google.cloud.aiplatform.v1beta1.Metric.AggregationMetric aggregation_metrics = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for aggregationMetrics.

getBleuSpec()

public BleuSpec getBleuSpec()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type	Description
BleuSpec	The bleuSpec.

getBleuSpecOrBuilder()

public BleuSpecOrBuilder getBleuSpecOrBuilder()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type	Description
BleuSpecOrBuilder

getDefaultInstanceForType()

public Metric getDefaultInstanceForType()

Returns
Type	Description
Metric

getExactMatchSpec()

public ExactMatchSpec getExactMatchSpec()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type	Description
ExactMatchSpec	The exactMatchSpec.

getExactMatchSpecOrBuilder()

public ExactMatchSpecOrBuilder getExactMatchSpecOrBuilder()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type	Description
ExactMatchSpecOrBuilder

getMetricSpecCase()

public Metric.MetricSpecCase getMetricSpecCase()

Returns
Type	Description
Metric.MetricSpecCase

getPairwiseMetricSpec()

public PairwiseMetricSpec getPairwiseMetricSpec()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type	Description
PairwiseMetricSpec	The pairwiseMetricSpec.

getPairwiseMetricSpecOrBuilder()

public PairwiseMetricSpecOrBuilder getPairwiseMetricSpecOrBuilder()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type	Description
PairwiseMetricSpecOrBuilder

getParserForType()

public Parser<Metric> getParserForType()

Returns
Type	Description
Parser<Metric>

Overrides

GeneratedMessageV3.getParserForType()

getPointwiseMetricSpec()

public PointwiseMetricSpec getPointwiseMetricSpec()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type	Description
PointwiseMetricSpec	The pointwiseMetricSpec.

getPointwiseMetricSpecOrBuilder()

public PointwiseMetricSpecOrBuilder getPointwiseMetricSpecOrBuilder()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type	Description
PointwiseMetricSpecOrBuilder

getRougeSpec()

public RougeSpec getRougeSpec()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type	Description
RougeSpec	The rougeSpec.

getRougeSpecOrBuilder()

public RougeSpecOrBuilder getRougeSpecOrBuilder()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type	Description
RougeSpecOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasBleuSpec()

public boolean hasBleuSpec()

Spec for bleu metric.

.google.cloud.aiplatform.v1beta1.BleuSpec bleu_spec = 5;

Returns
Type	Description
boolean	Whether the bleuSpec field is set.

hasExactMatchSpec()

public boolean hasExactMatchSpec()

Spec for exact match metric.

.google.cloud.aiplatform.v1beta1.ExactMatchSpec exact_match_spec = 4;

Returns
Type	Description
boolean	Whether the exactMatchSpec field is set.

hasPairwiseMetricSpec()

public boolean hasPairwiseMetricSpec()

Spec for pairwise metric.

.google.cloud.aiplatform.v1beta1.PairwiseMetricSpec pairwise_metric_spec = 3;

Returns
Type	Description
boolean	Whether the pairwiseMetricSpec field is set.

hasPointwiseMetricSpec()

public boolean hasPointwiseMetricSpec()

Spec for pointwise metric.

.google.cloud.aiplatform.v1beta1.PointwiseMetricSpec pointwise_metric_spec = 2;

Returns
Type	Description
boolean	Whether the pointwiseMetricSpec field is set.

hasRougeSpec()

public boolean hasRougeSpec()

Spec for rouge metric.

.google.cloud.aiplatform.v1beta1.RougeSpec rouge_spec = 6;

Returns
Type	Description
boolean	Whether the rougeSpec 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 Metric.Builder newBuilderForType()

Returns
Type	Description
Metric.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Metric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Metric.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 Metric.Builder toBuilder()

Returns
Type	Description
Metric.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException