Class Measurement (3.25.0)

public final class Measurement extends GeneratedMessageV3 implements MeasurementOrBuilder

A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.

Protobuf type google.cloud.aiplatform.v1.Measurement

Static Fields

ELAPSED_DURATION_FIELD_NUMBER

public static final int ELAPSED_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

STEP_COUNT_FIELD_NUMBER

public static final int STEP_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Measurement getDefaultInstance()
Returns
TypeDescription
Measurement

getDescriptor()

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

newBuilder()

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

newBuilder(Measurement prototype)

public static Measurement.Builder newBuilder(Measurement prototype)
Parameter
NameDescription
prototypeMeasurement
Returns
TypeDescription
Measurement.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Measurement getDefaultInstanceForType()
Returns
TypeDescription
Measurement

getElapsedDuration()

public Duration getElapsedDuration()

Output only. Time that the Trial has been running at the point of this Measurement.

.google.protobuf.Duration elapsed_duration = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Duration

The elapsedDuration.

getElapsedDurationOrBuilder()

public DurationOrBuilder getElapsedDurationOrBuilder()

Output only. Time that the Trial has been running at the point of this Measurement.

.google.protobuf.Duration elapsed_duration = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
DurationOrBuilder

getMetrics(int index)

public Measurement.Metric getMetrics(int index)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Measurement.Metric

getMetricsCount()

public int getMetricsCount()

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getMetricsList()

public List<Measurement.Metric> getMetricsList()

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Metric>

getMetricsOrBuilder(int index)

public Measurement.MetricOrBuilder getMetricsOrBuilder(int index)

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Measurement.MetricOrBuilder

getMetricsOrBuilderList()

public List<? extends Measurement.MetricOrBuilder> getMetricsOrBuilderList()

Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.

repeated .google.cloud.aiplatform.v1.Measurement.Metric metrics = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.Measurement.MetricOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStepCount()

public long getStepCount()

Output only. The number of steps the machine learning model has been trained for. Must be non-negative.

int64 step_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
long

The stepCount.

hasElapsedDuration()

public boolean hasElapsedDuration()

Output only. Time that the Trial has been running at the point of this Measurement.

.google.protobuf.Duration elapsed_duration = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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