org.mlflow.api.proto

Interface Service.SearchRunsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Service.SearchRuns, Service.SearchRuns.Builder

Enclosing class:

Service

public static interface Service.SearchRunsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Service.SearchExpression	getAndedExpressions(int index) This field is deprecated and will be removed in MLflow 1.0.
int	getAndedExpressionsCount() This field is deprecated and will be removed in MLflow 1.0.
List<Service.SearchExpression>	getAndedExpressionsList() This field is deprecated and will be removed in MLflow 1.0.
Service.SearchExpressionOrBuilder	getAndedExpressionsOrBuilder(int index) This field is deprecated and will be removed in MLflow 1.0.
List<? extends Service.SearchExpressionOrBuilder>	getAndedExpressionsOrBuilderList() This field is deprecated and will be removed in MLflow 1.0.
String	getExperimentIds(int index) List of experiment IDs to search over.
com.google.protobuf.ByteString	getExperimentIdsBytes(int index) List of experiment IDs to search over.
int	getExperimentIdsCount() List of experiment IDs to search over.
List<String>	getExperimentIdsList() List of experiment IDs to search over.
String	getFilter() A filter expression over params, metrics, and tags, allowing returning a subset of runs.
com.google.protobuf.ByteString	getFilterBytes() A filter expression over params, metrics, and tags, allowing returning a subset of runs.
Service.ViewType	getRunViewType() Whether to display only active, only deleted, or all runs.
boolean	hasFilter() A filter expression over params, metrics, and tags, allowing returning a subset of runs.
boolean	hasRunViewType() Whether to display only active, only deleted, or all runs.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getExperimentIdsList

List<String> getExperimentIdsList()

 List of experiment IDs to search over.
 

repeated string experiment_ids = 1;

getExperimentIdsCount

int getExperimentIdsCount()

 List of experiment IDs to search over.
 

repeated string experiment_ids = 1;

getExperimentIds

String getExperimentIds(int index)

 List of experiment IDs to search over.
 

repeated string experiment_ids = 1;

getExperimentIdsBytes

com.google.protobuf.ByteString getExperimentIdsBytes(int index)

 List of experiment IDs to search over.
 

repeated string experiment_ids = 1;

getAndedExpressionsList

List<Service.SearchExpression> getAndedExpressionsList()

 This field is deprecated and will be removed in MLflow 1.0.
 Expressions describing runs (AND-ed together when filtering runs).
 See 'filter' for a simpler on-the-wire representation of these expressions.
 

repeated .mlflow.SearchExpression anded_expressions = 2;

getAndedExpressions

Service.SearchExpression getAndedExpressions(int index)

 This field is deprecated and will be removed in MLflow 1.0.
 Expressions describing runs (AND-ed together when filtering runs).
 See 'filter' for a simpler on-the-wire representation of these expressions.
 

repeated .mlflow.SearchExpression anded_expressions = 2;

getAndedExpressionsCount

int getAndedExpressionsCount()

 This field is deprecated and will be removed in MLflow 1.0.
 Expressions describing runs (AND-ed together when filtering runs).
 See 'filter' for a simpler on-the-wire representation of these expressions.
 

repeated .mlflow.SearchExpression anded_expressions = 2;

getAndedExpressionsOrBuilderList

List<? extends Service.SearchExpressionOrBuilder> getAndedExpressionsOrBuilderList()

 This field is deprecated and will be removed in MLflow 1.0.
 Expressions describing runs (AND-ed together when filtering runs).
 See 'filter' for a simpler on-the-wire representation of these expressions.
 

repeated .mlflow.SearchExpression anded_expressions = 2;

getAndedExpressionsOrBuilder

Service.SearchExpressionOrBuilder getAndedExpressionsOrBuilder(int index)

 This field is deprecated and will be removed in MLflow 1.0.
 Expressions describing runs (AND-ed together when filtering runs).
 See 'filter' for a simpler on-the-wire representation of these expressions.
 

repeated .mlflow.SearchExpression anded_expressions = 2;

hasFilter

boolean hasFilter()

 A filter expression over params, metrics, and tags, allowing returning a subset of
 runs. The syntax is a subset of SQL which allows only ANDing together binary operations
 between a param/metric/tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can also select columns with spaces by using backticks or double quotes:
 ``metrics.`model class` = 'LinearRegression' and tags."user name" = 'Tomas'``
 Supported operators are =, !=, >, >=, <, <=, and LIKE.
 LIKE syntax: ``params.model_class LIKE 'Linear%'``
 'filter' may not be provided when anded_expressions is present; an INVALID_PARAMETER_VALUE
 error will be returned if both are specified.
 If both 'filter' and 'anded_expressions' are absent, all runs part of the given experiments
 will be returned.
 

optional string filter = 4;

getFilter

String getFilter()

 A filter expression over params, metrics, and tags, allowing returning a subset of
 runs. The syntax is a subset of SQL which allows only ANDing together binary operations
 between a param/metric/tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can also select columns with spaces by using backticks or double quotes:
 ``metrics.`model class` = 'LinearRegression' and tags."user name" = 'Tomas'``
 Supported operators are =, !=, >, >=, <, <=, and LIKE.
 LIKE syntax: ``params.model_class LIKE 'Linear%'``
 'filter' may not be provided when anded_expressions is present; an INVALID_PARAMETER_VALUE
 error will be returned if both are specified.
 If both 'filter' and 'anded_expressions' are absent, all runs part of the given experiments
 will be returned.
 

optional string filter = 4;

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 A filter expression over params, metrics, and tags, allowing returning a subset of
 runs. The syntax is a subset of SQL which allows only ANDing together binary operations
 between a param/metric/tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can also select columns with spaces by using backticks or double quotes:
 ``metrics.`model class` = 'LinearRegression' and tags."user name" = 'Tomas'``
 Supported operators are =, !=, >, >=, <, <=, and LIKE.
 LIKE syntax: ``params.model_class LIKE 'Linear%'``
 'filter' may not be provided when anded_expressions is present; an INVALID_PARAMETER_VALUE
 error will be returned if both are specified.
 If both 'filter' and 'anded_expressions' are absent, all runs part of the given experiments
 will be returned.
 

optional string filter = 4;

hasRunViewType

boolean hasRunViewType()

 Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
 

optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];

getRunViewType

Service.ViewType getRunViewType()

 Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
 

optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];