Package 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
    Description
    String
    getDatasetDigest()
    Dataset digest of the dataset associated with the metric, e.g.
    com.google.protobuf.ByteString
    getDatasetDigestBytes()
    Dataset digest of the dataset associated with the metric, e.g.
    String
    getDatasetName()
    The name of the dataset associated with the metric.
    com.google.protobuf.ByteString
    getDatasetNameBytes()
    The name of the dataset associated with the metric.
    String
    getKey()
    Name of the metric.
    com.google.protobuf.ByteString
    getKeyBytes()
    Name of the metric.
    String
    getModelId()
    ID of the logged model associated with the metric, if applicable
    com.google.protobuf.ByteString
    getModelIdBytes()
    ID of the logged model associated with the metric, if applicable
    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
    hasDatasetDigest()
    Dataset digest of the dataset associated with the metric, e.g.
    boolean
    hasDatasetName()
    The name of the dataset associated with the metric.
    boolean
    hasKey()
    Name of the metric.
    boolean
    hasModelId()
    ID of the logged model associated with the metric, if applicable
    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.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasRunId

      boolean hasRunId()
       ID of the run under which to log the metric. Must be provided.
      optional string run_id = 6;
      Returns:
      Whether the runId field is set.

    • getRunId

      String getRunId()
       ID of the run under which to log the metric. Must be provided.
      optional string run_id = 6;
      Returns:
      The runId.

    • getRunIdBytes

      com.google.protobuf.ByteString getRunIdBytes()
       ID of the run under which to log the metric. Must be provided.
      optional string run_id = 6;
      Returns:
      The bytes for runId.

    • 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;
      Returns:
      Whether the runUuid field is set.

    • 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;
      Returns:
      The runUuid.

    • 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;
      Returns:
      The bytes for runUuid.

    • hasKey

      boolean hasKey()
       Name of the metric.
      optional string key = 2 [(.mlflow.validate_required) = true];
      Returns:
      Whether the key field is set.

    • getKey

      String getKey()
       Name of the metric.
      optional string key = 2 [(.mlflow.validate_required) = true];
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
       Name of the metric.
      optional string key = 2 [(.mlflow.validate_required) = true];
      Returns:
      The bytes for key.

    • hasValue

      boolean hasValue()
       Double value of the metric being logged.
      optional double value = 3 [(.mlflow.validate_required) = true];
      Returns:
      Whether the value field is set.

    • getValue

      double getValue()
       Double value of the metric being logged.
      optional double value = 3 [(.mlflow.validate_required) = true];
      Returns:
      The value.

    • hasTimestamp

      boolean hasTimestamp()
       Unix timestamp in milliseconds at the time metric was logged.
      optional int64 timestamp = 4 [(.mlflow.validate_required) = true];
      Returns:
      Whether the timestamp field is set.

    • getTimestamp

      long getTimestamp()
       Unix timestamp in milliseconds at the time metric was logged.
      optional int64 timestamp = 4 [(.mlflow.validate_required) = true];
      Returns:
      The timestamp.

    • hasStep

      boolean hasStep()
       Step at which to log the metric
      optional int64 step = 5 [default = 0];
      Returns:
      Whether the step field is set.

    • getStep

      long getStep()
       Step at which to log the metric
      optional int64 step = 5 [default = 0];
      Returns:
      The step.

    • hasModelId

      boolean hasModelId()
       ID of the logged model associated with the metric, if applicable
      optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      Whether the modelId field is set.

    • getModelId

      String getModelId()
       ID of the logged model associated with the metric, if applicable
      optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      The modelId.

    • getModelIdBytes

      com.google.protobuf.ByteString getModelIdBytes()
       ID of the logged model associated with the metric, if applicable
      optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      The bytes for modelId.

    • hasDatasetName

      boolean hasDatasetName()
       The name of the dataset associated with the metric.
 E.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3”
      optional string dataset_name = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      Whether the datasetName field is set.

    • getDatasetName

      String getDatasetName()
       The name of the dataset associated with the metric.
 E.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3”
      optional string dataset_name = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      The datasetName.

    • getDatasetNameBytes

      com.google.protobuf.ByteString getDatasetNameBytes()
       The name of the dataset associated with the metric.
 E.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3”
      optional string dataset_name = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      The bytes for datasetName.

    • hasDatasetDigest

      boolean hasDatasetDigest()
       Dataset digest of the dataset associated with the metric,
 e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
      optional string dataset_digest = 9 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      Whether the datasetDigest field is set.

    • getDatasetDigest

      String getDatasetDigest()
       Dataset digest of the dataset associated with the metric,
 e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
      optional string dataset_digest = 9 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      The datasetDigest.

    • getDatasetDigestBytes

      com.google.protobuf.ByteString getDatasetDigestBytes()
       Dataset digest of the dataset associated with the metric,
 e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
      optional string dataset_digest = 9 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      The bytes for datasetDigest.