Package org.mlflow.api.proto

Interface Service.GetMetricHistoryBulkIntervalOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getEndStep()
    Optional end step to only fetch metrics before the specified step.
    int
    getMaxResults()
    Maximum number of results to fetch per run specified.
    String
    getMetricKey()
    Name of the metric.
    com.google.protobuf.ByteString
    getMetricKeyBytes()
    Name of the metric.
    String
    getRunIds(int index)
    ID(s) of the run(s) from which to fetch metric values.
    com.google.protobuf.ByteString
    getRunIdsBytes(int index)
    ID(s) of the run(s) from which to fetch metric values.
    int
    getRunIdsCount()
    ID(s) of the run(s) from which to fetch metric values.
    List<String>
    getRunIdsList()
    ID(s) of the run(s) from which to fetch metric values.
    int
    getStartStep()
    Optional start step to only fetch metrics after the specified step.
    boolean
    hasEndStep()
    Optional end step to only fetch metrics before the specified step.
    boolean
    hasMaxResults()
    Maximum number of results to fetch per run specified.
    boolean
    hasMetricKey()
    Name of the metric.
    boolean
    hasStartStep()
    Optional start step to only fetch metrics after the specified step.

    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

    • getRunIdsList

      List<String> getRunIdsList()
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Returns:
      A list containing the runIds.

    • getRunIdsCount

      int getRunIdsCount()
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Returns:
      The count of runIds.

    • getRunIds

      String getRunIds(int index)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Parameters:
      index - The index of the element to return.
      Returns:
      The runIds at the given index.

    • getRunIdsBytes

      com.google.protobuf.ByteString getRunIdsBytes(int index)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the runIds at the given index.

    • hasMetricKey

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

    • getMetricKey

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

    • getMetricKeyBytes

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

    • hasStartStep

      boolean hasStartStep()
       Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
      optional int32 start_step = 3;
      Returns:
      Whether the startStep field is set.

    • getStartStep

      int getStartStep()
       Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
      optional int32 start_step = 3;
      Returns:
      The startStep.

    • hasEndStep

      boolean hasEndStep()
       Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
      optional int32 end_step = 4;
      Returns:
      Whether the endStep field is set.

    • getEndStep

      int getEndStep()
       Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
      optional int32 end_step = 4;
      Returns:
      The endStep.

    • hasMaxResults

      boolean hasMaxResults()
       Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
      optional int32 max_results = 5;
      Returns:
      Whether the maxResults field is set.

    • getMaxResults

      int getMaxResults()
       Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
      optional int32 max_results = 5;
      Returns:
      The maxResults.