Package org.mlflow.api.proto

Class ModelRegistry.ModelMetric

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, ModelRegistry.ModelMetricOrBuilder
    Enclosing class:
    ModelRegistry
    public static final class ModelRegistry.ModelMetric
extends com.google.protobuf.GeneratedMessageV3
implements ModelRegistry.ModelMetricOrBuilder
     Metric associated with a model, represented as a key-value pair.
 Copied from MLflow metric
    Protobuf type mlflow.ModelMetric
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ModelRegistry.ModelMetric.Builder
      Metric associated with a model, 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

    • Method Detail

      • newInstance

        protected java.lang.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

      • getKeyBytes

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

      • hasValue

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

      • hasTimestamp

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

      • hasStep

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

      • 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 ModelRegistry.ModelMetricOrBuilder
        Returns:
        Whether the datasetName field is set.

      • getDatasetName

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

      • getDatasetDigest

        public 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];
        Specified by:
        getDatasetDigest in interface ModelRegistry.ModelMetricOrBuilder
        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 ModelRegistry.ModelMetricOrBuilder
        Returns:
        The bytes for datasetDigest.

      • hasModelId

        public boolean hasModelId()
         The ID of the LoggedModel or Registered Model Version associated with
 the metric
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        hasModelId in interface ModelRegistry.ModelMetricOrBuilder
        Returns:
        Whether the modelId field is set.

      • getModelId

        public java.lang.String getModelId()
         The ID of the LoggedModel or Registered Model Version associated with
 the metric
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getModelId in interface ModelRegistry.ModelMetricOrBuilder
        Returns:
        The modelId.

      • getModelIdBytes

        public com.google.protobuf.ByteString getModelIdBytes()
         The ID of the LoggedModel or Registered Model Version associated with
 the metric
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getModelIdBytes in interface ModelRegistry.ModelMetricOrBuilder
        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 ModelRegistry.ModelMetricOrBuilder
        Returns:
        Whether the runId field is set.

      • getRunId

        public java.lang.String getRunId()
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getRunId in interface ModelRegistry.ModelMetricOrBuilder
        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 ModelRegistry.ModelMetricOrBuilder
        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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 ModelRegistry.ModelMetric parseFrom​(java.nio.ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.ModelMetric parseFrom​(java.nio.ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.ModelMetric parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.ModelMetric parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.ModelMetric parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static ModelRegistry.ModelMetric parseFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ModelRegistry.ModelMetric parseFrom​(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ModelRegistry.ModelMetric parseDelimitedFrom​(java.io.InputStream input)
                                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ModelRegistry.ModelMetric parseDelimitedFrom​(java.io.InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ModelRegistry.ModelMetric parseFrom​(com.google.protobuf.CodedInputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ModelRegistry.ModelMetric parseFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ModelRegistry.ModelMetric.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ModelRegistry.ModelMetric> 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 ModelRegistry.ModelMetric getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder