Package org.mlflow.api.proto

Class Service.SearchLoggedModels

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Service.SearchLoggedModelsOrBuilder
    Enclosing class:
    Service
    public static final class Service.SearchLoggedModels
extends com.google.protobuf.GeneratedMessageV3
implements Service.SearchLoggedModelsOrBuilder
    Protobuf type mlflow.SearchLoggedModels
    See Also:
    Serialized Form

    • 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

      • getExperimentIdsList

        public com.google.protobuf.ProtocolStringList getExperimentIdsList()
         IDs of the Experiments in which to search for Logged Models.
        repeated string experiment_ids = 1;
        Specified by:
        getExperimentIdsList in interface Service.SearchLoggedModelsOrBuilder
        Returns:
        A list containing the experimentIds.

      • getExperimentIdsCount

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

      • getExperimentIds

        public java.lang.String getExperimentIds​(int index)
         IDs of the Experiments in which to search for Logged Models.
        repeated string experiment_ids = 1;
        Specified by:
        getExperimentIds in interface Service.SearchLoggedModelsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The experimentIds at the given index.

      • getExperimentIdsBytes

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

      • hasFilter

        public 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;
        Specified by:
        hasFilter in interface Service.SearchLoggedModelsOrBuilder
        Returns:
        Whether the filter field is set.

      • getFilter

        public java.lang.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;
        Specified by:
        getFilter in interface Service.SearchLoggedModelsOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public 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;
        Specified by:
        getFilterBytes in interface Service.SearchLoggedModelsOrBuilder
        Returns:
        The bytes for filter.

      • getDatasetsList

        public java.util.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;
        Specified by:
        getDatasetsList in interface Service.SearchLoggedModelsOrBuilder

      • getDatasetsOrBuilderList

        public java.util.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;
        Specified by:
        getDatasetsOrBuilderList in interface Service.SearchLoggedModelsOrBuilder

      • getDatasetsCount

        public 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;
        Specified by:
        getDatasetsCount in interface Service.SearchLoggedModelsOrBuilder

      • getDatasets

        public 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;
        Specified by:
        getDatasets in interface Service.SearchLoggedModelsOrBuilder

      • getDatasetsOrBuilder

        public 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;
        Specified by:
        getDatasetsOrBuilder in interface Service.SearchLoggedModelsOrBuilder

      • hasMaxResults

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

      • getMaxResults

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

      • getOrderByCount

        public int getOrderByCount()
         List of columns for ordering the results, with additional fields for sorting criteria.
        repeated .mlflow.SearchLoggedModels.OrderBy order_by = 4;
        Specified by:
        getOrderByCount in interface Service.SearchLoggedModelsOrBuilder

      • hasPageToken

        public boolean hasPageToken()
         Token indicating the page of Logged Models to fetch.
        optional string page_token = 5;
        Specified by:
        hasPageToken in interface Service.SearchLoggedModelsOrBuilder
        Returns:
        Whether the pageToken field is set.

      • getPageToken

        public java.lang.String getPageToken()
         Token indicating the page of Logged Models to fetch.
        optional string page_token = 5;
        Specified by:
        getPageToken in interface Service.SearchLoggedModelsOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

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

      • 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 Service.SearchLoggedModels parseFrom​(java.nio.ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Service.SearchLoggedModels parseFrom​(java.io.InputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static Service.SearchLoggedModels parseDelimitedFrom​(java.io.InputStream input)
                                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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