Package org.mlflow.api.proto

Interface Service.MetricOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Service.Metric, Service.Metric.Builder
    Enclosing class:
    Service
    public static interface Service.MetricOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.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.
      java.lang.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.
      java.lang.String getKey()
      Key identifying this metric.
      com.google.protobuf.ByteString getKeyBytes()
      Key identifying this metric.
      java.lang.String getModelId()
      The ID of the LoggedModel or Registered Model Version associated with the metric, if applicable.
      com.google.protobuf.ByteString getModelIdBytes()
      The ID of the LoggedModel or Registered Model Version associated with the metric, if applicable.
      java.lang.String getRunId()
      The ID of the run containing the metric.
      com.google.protobuf.ByteString getRunIdBytes()
      The ID of the run containing the metric.
      long getStep()
      Step at which to log the metric.
      long getTimestamp()
      The timestamp at which this metric was recorded.
      double getValue()
      Value associated with this metric.
      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()
      Key identifying this metric.
      boolean hasModelId()
      The ID of the LoggedModel or Registered Model Version associated with the metric, if applicable.
      boolean hasRunId()
      The ID of the run containing the metric.
      boolean hasStep()
      Step at which to log the metric.
      boolean hasTimestamp()
      The timestamp at which this metric was recorded.
      boolean hasValue()
      Value associated with this metric.

      • 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 Detail

      • hasKey

        boolean hasKey()
         Key identifying this metric.
        optional string key = 1;
        Returns:
        Whether the key field is set.

      • getKey

        java.lang.String getKey()
         Key identifying this metric.
        optional string key = 1;
        Returns:
        The key.

      • getKeyBytes

        com.google.protobuf.ByteString getKeyBytes()
         Key identifying this metric.
        optional string key = 1;
        Returns:
        The bytes for key.

      • hasValue

        boolean hasValue()
         Value associated with this metric.
        optional double value = 2;
        Returns:
        Whether the value field is set.

      • getValue

        double getValue()
         Value associated with this metric.
        optional double value = 2;
        Returns:
        The value.

      • hasTimestamp

        boolean hasTimestamp()
         The timestamp at which this metric was recorded.
        optional int64 timestamp = 3;
        Returns:
        Whether the timestamp field is set.

      • getTimestamp

        long getTimestamp()
         The timestamp at which this metric was recorded.
        optional int64 timestamp = 3;
        Returns:
        The timestamp.

      • hasStep

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

      • getStep

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

      • 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 = 5 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        Whether the datasetName field is set.

      • getDatasetName

        java.lang.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 = 5 [(.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 = 5 [(.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 = 6 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        Whether the datasetDigest field is set.

      • getDatasetDigest

        java.lang.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 = 6 [(.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 = 6 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        The bytes for datasetDigest.

      • hasModelId

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

      • getModelId

        java.lang.String getModelId()
         The ID of the LoggedModel or Registered Model Version associated with
 the metric, if applicable.
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        The modelId.

      • getModelIdBytes

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

      • hasRunId

        boolean hasRunId()
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        Whether the runId field is set.

      • getRunId

        java.lang.String getRunId()
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        The runId.

      • getRunIdBytes

        com.google.protobuf.ByteString getRunIdBytes()
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        The bytes for runId.