Package org.mlflow.api.proto

Interface Service.SearchLoggedModelsOrBuilder

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

  • Method Details

    • getExperimentIdsList

      List<String> getExperimentIdsList()
       IDs of the Experiments in which to search for Logged Models.
      repeated string experiment_ids = 1;
      Returns:
      A list containing the experimentIds.

    • getExperimentIdsCount

      int getExperimentIdsCount()
       IDs of the Experiments in which to search for Logged Models.
      repeated string experiment_ids = 1;
      Returns:
      The count of experimentIds.

    • getExperimentIds

      String getExperimentIds(int index)
       IDs of the Experiments in which to search for Logged Models.
      repeated string experiment_ids = 1;
      Parameters:
      index - The index of the element to return.
      Returns:
      The experimentIds at the given index.

    • getExperimentIdsBytes

      com.google.protobuf.ByteString getExperimentIdsBytes(int index)
       IDs of the Experiments in which to search for Logged Models.
      repeated string experiment_ids = 1;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the experimentIds at the given index.

    • hasFilter

      boolean hasFilter()
       A filter expression over Logged Model info and data that allows returning a subset of
 Logged Models. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``params.alpha < 0.3 AND metrics.accuracy > 0.9``.
      optional string filter = 2;
      Returns:
      Whether the filter field is set.

    • getFilter

      String getFilter()
       A filter expression over Logged Model info and data that allows returning a subset of
 Logged Models. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``params.alpha < 0.3 AND metrics.accuracy > 0.9``.
      optional string filter = 2;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       A filter expression over Logged Model info and data that allows returning a subset of
 Logged Models. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``params.alpha < 0.3 AND metrics.accuracy > 0.9``.
      optional string filter = 2;
      Returns:
      The bytes for filter.

    • getDatasetsList

      List<Service.SearchLoggedModels.Dataset> getDatasetsList()
       List of datasets on which to apply the metrics filter clauses.
 For example, a filter with `metrics.accuracy > 0.9` and dataset info with name "test_dataset"
 means we will return all logged models with accuracy > 0.9 on the test_dataset.
 Metric values from ANY dataset matching the criteria are considered.
 If no datasets are specified, then metrics across all datasets are considered in the filter.
      repeated .mlflow.SearchLoggedModels.Dataset datasets = 6;

    • getDatasets

      Service.SearchLoggedModels.Dataset getDatasets(int index)
       List of datasets on which to apply the metrics filter clauses.
 For example, a filter with `metrics.accuracy > 0.9` and dataset info with name "test_dataset"
 means we will return all logged models with accuracy > 0.9 on the test_dataset.
 Metric values from ANY dataset matching the criteria are considered.
 If no datasets are specified, then metrics across all datasets are considered in the filter.
      repeated .mlflow.SearchLoggedModels.Dataset datasets = 6;

    • getDatasetsCount

      int getDatasetsCount()
       List of datasets on which to apply the metrics filter clauses.
 For example, a filter with `metrics.accuracy > 0.9` and dataset info with name "test_dataset"
 means we will return all logged models with accuracy > 0.9 on the test_dataset.
 Metric values from ANY dataset matching the criteria are considered.
 If no datasets are specified, then metrics across all datasets are considered in the filter.
      repeated .mlflow.SearchLoggedModels.Dataset datasets = 6;

    • getDatasetsOrBuilderList

      List<? extends Service.SearchLoggedModels.DatasetOrBuilder> getDatasetsOrBuilderList()
       List of datasets on which to apply the metrics filter clauses.
 For example, a filter with `metrics.accuracy > 0.9` and dataset info with name "test_dataset"
 means we will return all logged models with accuracy > 0.9 on the test_dataset.
 Metric values from ANY dataset matching the criteria are considered.
 If no datasets are specified, then metrics across all datasets are considered in the filter.
      repeated .mlflow.SearchLoggedModels.Dataset datasets = 6;

    • getDatasetsOrBuilder

      Service.SearchLoggedModels.DatasetOrBuilder getDatasetsOrBuilder(int index)
       List of datasets on which to apply the metrics filter clauses.
 For example, a filter with `metrics.accuracy > 0.9` and dataset info with name "test_dataset"
 means we will return all logged models with accuracy > 0.9 on the test_dataset.
 Metric values from ANY dataset matching the criteria are considered.
 If no datasets are specified, then metrics across all datasets are considered in the filter.
      repeated .mlflow.SearchLoggedModels.Dataset datasets = 6;

    • hasMaxResults

      boolean hasMaxResults()
       Maximum number of Logged Models to return. Max threshold is 50.
      optional int32 max_results = 3 [default = 50];
      Returns:
      Whether the maxResults field is set.

    • getMaxResults

      int getMaxResults()
       Maximum number of Logged Models to return. Max threshold is 50.
      optional int32 max_results = 3 [default = 50];
      Returns:
      The maxResults.

    • getOrderByList

      List<Service.SearchLoggedModels.OrderBy> getOrderByList()
       List of columns for ordering the results, with additional fields for sorting criteria.
      repeated .mlflow.SearchLoggedModels.OrderBy order_by = 4;

    • getOrderBy

      Service.SearchLoggedModels.OrderBy getOrderBy(int index)
       List of columns for ordering the results, with additional fields for sorting criteria.
      repeated .mlflow.SearchLoggedModels.OrderBy order_by = 4;

    • getOrderByCount

      int getOrderByCount()
       List of columns for ordering the results, with additional fields for sorting criteria.
      repeated .mlflow.SearchLoggedModels.OrderBy order_by = 4;

    • getOrderByOrBuilderList

      List<? extends Service.SearchLoggedModels.OrderByOrBuilder> getOrderByOrBuilderList()
       List of columns for ordering the results, with additional fields for sorting criteria.
      repeated .mlflow.SearchLoggedModels.OrderBy order_by = 4;

    • getOrderByOrBuilder

      Service.SearchLoggedModels.OrderByOrBuilder getOrderByOrBuilder(int index)
       List of columns for ordering the results, with additional fields for sorting criteria.
      repeated .mlflow.SearchLoggedModels.OrderBy order_by = 4;

    • hasPageToken

      boolean hasPageToken()
       Token indicating the page of Logged Models to fetch.
      optional string page_token = 5;
      Returns:
      Whether the pageToken field is set.

    • getPageToken

      String getPageToken()
       Token indicating the page of Logged Models to fetch.
      optional string page_token = 5;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Token indicating the page of Logged Models to fetch.
      optional string page_token = 5;
      Returns:
      The bytes for pageToken.