org.mlflow.api.proto

Interface Service.LogMetricOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Service.LogMetric, Service.LogMetric.Builder

Enclosing class:

Service

public static interface Service.LogMetricOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getKey() Name of the metric.
com.google.protobuf.ByteString	getKeyBytes() Name of the metric.
String	getRunId() ID of the run under which to log the metric.
com.google.protobuf.ByteString	getRunIdBytes() ID of the run under which to log the metric.
String	getRunUuid() [Deprecated, use run_id instead] ID of the run under which to log the metric.
com.google.protobuf.ByteString	getRunUuidBytes() [Deprecated, use run_id instead] ID of the run under which to log the metric.
long	getStep() Step at which to log the metric
long	getTimestamp() Unix timestamp in milliseconds at the time metric was logged.
double	getValue() Double value of the metric being logged.
boolean	hasKey() Name of the metric.
boolean	hasRunId() ID of the run under which to log the metric.
boolean	hasRunUuid() [Deprecated, use run_id instead] ID of the run under which to log the metric.
boolean	hasStep() Step at which to log the metric
boolean	hasTimestamp() Unix timestamp in milliseconds at the time metric was logged.
boolean	hasValue() Double value of the metric being logged.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasRunId

boolean hasRunId()

 ID of the run under which to log the metric. Must be provided.
 

optional string run_id = 6;

getRunId

String getRunId()

 ID of the run under which to log the metric. Must be provided.
 

optional string run_id = 6;

getRunIdBytes

com.google.protobuf.ByteString getRunIdBytes()

 ID of the run under which to log the metric. Must be provided.
 

optional string run_id = 6;

hasRunUuid

boolean hasRunUuid()

 [Deprecated, use run_id instead] ID of the run under which to log the metric. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

getRunUuid

String getRunUuid()

 [Deprecated, use run_id instead] ID of the run under which to log the metric. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

getRunUuidBytes

com.google.protobuf.ByteString getRunUuidBytes()

 [Deprecated, use run_id instead] ID of the run under which to log the metric. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

hasKey

boolean hasKey()

 Name of the metric.
 

optional string key = 2 [(.mlflow.validate_required) = true];

getKey

String getKey()

 Name of the metric.
 

optional string key = 2 [(.mlflow.validate_required) = true];

getKeyBytes

com.google.protobuf.ByteString getKeyBytes()

 Name of the metric.
 

optional string key = 2 [(.mlflow.validate_required) = true];

hasValue

boolean hasValue()

 Double value of the metric being logged.
 

optional double value = 3 [(.mlflow.validate_required) = true];

getValue

double getValue()

 Double value of the metric being logged.
 

optional double value = 3 [(.mlflow.validate_required) = true];

hasTimestamp

boolean hasTimestamp()

 Unix timestamp in milliseconds at the time metric was logged.
 

optional int64 timestamp = 4 [(.mlflow.validate_required) = true];

getTimestamp

long getTimestamp()

 Unix timestamp in milliseconds at the time metric was logged.
 

optional int64 timestamp = 4 [(.mlflow.validate_required) = true];

hasStep

boolean hasStep()

 Step at which to log the metric
 

optional int64 step = 5 [default = 0];

getStep

long getStep()

 Step at which to log the metric
 

optional int64 step = 5 [default = 0];