Class Metric (3.59.0)

public final class Metric extends GeneratedMessageV3 implements MetricOrBuilder

The metric used for dataset level evaluation.

Protobuf type google.cloud.aiplatform.v1beta1.Metric

Implements

MetricOrBuilder

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

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

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Metric.Builder toBuilder()
Returns
Type Description
Metric.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException