Package org.mlflow.api.proto

Class ModelRegistry.ModelMetric

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.ModelRegistry.ModelMetric
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, 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:

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

    • getKey

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

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

    • getValue

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

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

    • getTimestamp

      public long getTimestamp()
       The timestamp at which this metric was recorded.
      optional int64 timestamp = 3;
      Specified by:
      getTimestamp in interface ModelRegistry.ModelMetricOrBuilder
      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 ModelRegistry.ModelMetricOrBuilder
      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 ModelRegistry.ModelMetricOrBuilder
      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 ModelRegistry.ModelMetricOrBuilder
      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 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 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 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 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 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 ModelRegistry.ModelMetric parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ModelRegistry.ModelMetric parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

      public static ModelRegistry.ModelMetric parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      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

    • newBuilder

      public static ModelRegistry.ModelMetric.Builder newBuilder()

    • newBuilder

      public static ModelRegistry.ModelMetric.Builder newBuilder(ModelRegistry.ModelMetric prototype)

    • 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

    • getDefaultInstance

      public static ModelRegistry.ModelMetric getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ModelRegistry.ModelMetric> parser()

    • 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