Package org.mlflow.api.proto

Class Service.Metric

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Service.Metric
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Service.MetricOrBuilder
Enclosing class:
Service
public static final class Service.Metric extends com.google.protobuf.GeneratedMessageV3 implements Service.MetricOrBuilder
 Metric associated with a run, represented as a key-value pair.
Protobuf type mlflow.Metric
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Service.Metric.Builder
    Metric associated with a run, represented as a key-value pair.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATASET_DIGEST_FIELD_NUMBER
     
    static final int
    DATASET_NAME_FIELD_NUMBER
     
    static final int
    KEY_FIELD_NUMBER
     
    static final int
    MODEL_ID_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<Service.Metric>
    PARSER
    Deprecated.
    static final int
    RUN_ID_FIELD_NUMBER
     
    static final int
    STEP_FIELD_NUMBER
     
    static final int
    TIMESTAMP_FIELD_NUMBER
     
    static final int
    VALUE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    static Service.Metric
    getDefaultInstance()
     
    Service.Metric
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getKey()
    Key identifying this metric.
    com.google.protobuf.ByteString
    getKeyBytes()
    Key identifying this metric.
    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.
    com.google.protobuf.Parser<Service.Metric>
    getParserForType()
     
    String
    getRunId()
    The ID of the run containing the metric.
    com.google.protobuf.ByteString
    getRunIdBytes()
    The ID of the run containing the metric.
    int
    getSerializedSize()
     
    long
    getStep()
    Step at which to log the metric.
    long
    getTimestamp()
    The timestamp at which this metric was recorded.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    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.
    int
    hashCode()
     
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Service.Metric.Builder
    newBuilder()
     
    static Service.Metric.Builder
    newBuilder(Service.Metric prototype)
     
    Service.Metric.Builder
    newBuilderForType()
     
    protected Service.Metric.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Service.Metric
    parseDelimitedFrom(InputStream input)
     
    static Service.Metric
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Metric
    parseFrom(byte[] data)
     
    static Service.Metric
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Metric
    parseFrom(com.google.protobuf.ByteString data)
     
    static Service.Metric
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Metric
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Service.Metric
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Metric
    parseFrom(InputStream input)
     
    static Service.Metric
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.Metric
    parseFrom(ByteBuffer data)
     
    static Service.Metric
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Service.Metric>
    parser()
     
    Service.Metric.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasKey

      public boolean hasKey()
       Key identifying this metric.
      optional string key = 1;
      Specified by:
      hasKey in interface Service.MetricOrBuilder
      Returns:
      Whether the key field is set.

    • getKey

      public String getKey()
       Key identifying this metric.
      optional string key = 1;
      Specified by:
      getKey in interface Service.MetricOrBuilder
      Returns:
      The key.

    • getKeyBytes

      public com.google.protobuf.ByteString getKeyBytes()
       Key identifying this metric.
      optional string key = 1;
      Specified by:
      getKeyBytes in interface Service.MetricOrBuilder
      Returns:
      The bytes for key.

    • hasValue

      public boolean hasValue()
       Value associated with this metric.
      optional double value = 2;
      Specified by:
      hasValue in interface Service.MetricOrBuilder
      Returns:
      Whether the value field is set.

    • getValue

      public double getValue()
       Value associated with this metric.
      optional double value = 2;
      Specified by:
      getValue in interface Service.MetricOrBuilder
      Returns:
      The value.

    • hasTimestamp

      public boolean hasTimestamp()
       The timestamp at which this metric was recorded.
      optional int64 timestamp = 3;
      Specified by:
      hasTimestamp in interface Service.MetricOrBuilder
      Returns:
      Whether the timestamp field is set.

    • getTimestamp

      public long getTimestamp()
       The timestamp at which this metric was recorded.
      optional int64 timestamp = 3;
      Specified by:
      getTimestamp in interface Service.MetricOrBuilder
      Returns:
      The timestamp.

    • hasStep

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

    • getStep

      public long getStep()
       Step at which to log the metric.
      optional int64 step = 4 [default = 0];
      Specified by:
      getStep in interface Service.MetricOrBuilder
      Returns:
      The step.

    • hasDatasetName

      public 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];
      Specified by:
      hasDatasetName in interface Service.MetricOrBuilder
      Returns:
      Whether the datasetName field is set.

    • getDatasetName

      public 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];
      Specified by:
      getDatasetName in interface Service.MetricOrBuilder
      Returns:
      The datasetName.

    • getDatasetNameBytes

      public 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];
      Specified by:
      getDatasetNameBytes in interface Service.MetricOrBuilder
      Returns:
      The bytes for datasetName.

    • hasDatasetDigest

      public 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];
      Specified by:
      hasDatasetDigest in interface Service.MetricOrBuilder
      Returns:
      Whether the datasetDigest field is set.

    • getDatasetDigest

      public 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];
      Specified by:
      getDatasetDigest in interface Service.MetricOrBuilder
      Returns:
      The datasetDigest.

    • getDatasetDigestBytes

      public 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];
      Specified by:
      getDatasetDigestBytes in interface Service.MetricOrBuilder
      Returns:
      The bytes for datasetDigest.

    • hasModelId

      public 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];
      Specified by:
      hasModelId in interface Service.MetricOrBuilder
      Returns:
      Whether the modelId field is set.

    • getModelId

      public 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];
      Specified by:
      getModelId in interface Service.MetricOrBuilder
      Returns:
      The modelId.

    • getModelIdBytes

      public 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];
      Specified by:
      getModelIdBytes in interface Service.MetricOrBuilder
      Returns:
      The bytes for modelId.

    • hasRunId

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

    • getRunId

      public String getRunId()
       The ID of the run containing the metric.
      optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Specified by:
      getRunId in interface Service.MetricOrBuilder
      Returns:
      The runId.

    • getRunIdBytes

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Service.Metric parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.Metric parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.Metric parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.Metric parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.Metric parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.Metric parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.Metric parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Service.Metric parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Service.Metric parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Service.Metric parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Service.Metric parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Service.Metric parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Service.Metric.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Service.Metric.Builder newBuilder()

    • newBuilder

      public static Service.Metric.Builder newBuilder(Service.Metric prototype)

    • toBuilder

      public Service.Metric.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Service.Metric.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Service.Metric getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Service.Metric> parser()

    • getParserForType

      public com.google.protobuf.Parser<Service.Metric> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Service.Metric getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder