CM-4553: Implemented CometApi.getExperiments()

Author: yaricom

comet-java-client/src/main/java/ml/comet/experiment/CometApi.java

@@ -46,6 +46,20 @@ public interface CometApi extends Closeable {
      */
     List<ExperimentMetadata> getAllExperiments(String projectId);
 
+    /**
+     * Gets metadata of all experiments matching the following searching criteria.
+     *
+     * @param workspaceName         the name of workspace where experiments defined.
+     * @param projectName           the name of project associated with experiments (optional).
+     * @param experimentNamePattern the regex pattern for name of specific experiment (optional).
+     * @return the list of metadata objects associated with experiments matching provided search criteria.
+     */
+    List<ExperimentMetadata> getExperiments(String workspaceName, String projectName, String experimentNamePattern);
+
+    List<ExperimentMetadata> getExperiments(String workspaceName, String projectName);
+
+    List<ExperimentMetadata> getExperiments(String workspaceName);
+
     /**
      * Register model defined in the specified experiment in the Comet's model registry.
      *

comet-java-client/src/main/java/ml/comet/experiment/impl/CometApiImpl.java

@@ -54,6 +54,7 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.function.Function;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import java.util.zip.ZipInputStream;
 
@@ -153,6 +154,55 @@ public List<ExperimentMetadata> getAllExperiments(@NonNull String projectId) {
                         ArrayList::addAll);
     }
 
+    @Override
+    public List<ExperimentMetadata> getExperiments(@NonNull String workspaceName, @NonNull String projectName) {
+        return restApiClient.getAllExperiments(projectName, workspaceName)
+                .doOnError(ex -> this.logger.error(
+                        "Failed to read experiments found in the project {} of workspace {}",
+                        projectName, workspaceName, ex))
+                .blockingGet()
+                .getExperiments()
+                .stream()
+                .collect(ArrayList::new,
+                        (metadataList, metadataRest) -> metadataList.add(metadataRest.toExperimentMetadata()),
+                        ArrayList::addAll);
+    }
+
+    @Override
+    public List<ExperimentMetadata> getExperiments(@NonNull String workspaceName) {
+        return this.getAllProjects(workspaceName)
+                .stream()
+                .collect(ArrayList::new, (metadataList, project) -> this.getAllExperiments(project.getProjectId()),
+                        ArrayList::addAll);
+    }
+
+    @Override
+    public List<ExperimentMetadata> getExperiments(
+            @NonNull String workspaceName, String projectName, String experimentNamePattern) {
+
+        if (StringUtils.isBlank(projectName)) {
+            // no project name provided
+            if (!StringUtils.isBlank(experimentNamePattern)) {
+                throw new IllegalArgumentException(
+                        "you must specify projectName when experimentNamePattern is provided");
+            }
+            // get experiments for all projects in the workspace
+            return this.getExperiments(workspaceName);
+        }
+
+        if (StringUtils.isBlank(experimentNamePattern)) {
+            // no experiment name pattern provided
+            return this.getExperiments(workspaceName, projectName);
+        }
+
+        // return list of experiments with names matching provided regex
+        return this.getExperiments(workspaceName, projectName)
+                .stream()
+                .filter(experimentMetadata ->
+                        Pattern.matches(experimentNamePattern, experimentMetadata.getExperimentName()))
+                .collect(Collectors.toList());
+    }
+
     @Override
     public ModelRegistryRecord registerModel(@NonNull final Model model, @NonNull final String experimentKey) {
         // get list of experiment models
@@ -393,8 +443,8 @@ public void updateRegistryModelVersion(@NonNull String registryName, @NonNull St
         Optional<ModelVersionOverview> versionOverviewOptional = this.getRegistryModelVersion(
                 registryName, workspace, version);
         if (!versionOverviewOptional.isPresent()) {
-           throw new ModelVersionNotFoundException(
-                   getString(REGISTRY_MODEL_VERSION_NOT_FOUND, version, workspace, registryName));
+            throw new ModelVersionNotFoundException(
+                    getString(REGISTRY_MODEL_VERSION_NOT_FOUND, version, workspace, registryName));
         }
 
         // update model version details

comet-java-client/src/main/java/ml/comet/experiment/impl/RestApiClient.java

@@ -115,6 +115,7 @@
 import static ml.comet.experiment.impl.constants.QueryParamName.MODEL_ITEM_ID;
 import static ml.comet.experiment.impl.constants.QueryParamName.MODEL_NAME;
 import static ml.comet.experiment.impl.constants.QueryParamName.PROJECT_ID;
+import static ml.comet.experiment.impl.constants.QueryParamName.PROJECT_NAME;
 import static ml.comet.experiment.impl.constants.QueryParamName.TYPE;
 import static ml.comet.experiment.impl.constants.QueryParamName.WORKSPACE_NAME;
 import static ml.comet.experiment.impl.http.ConnectionUtils.checkResponseStatus;
@@ -164,6 +165,13 @@ Single<GetExperimentsResponse> getAllExperiments(String projectId) {
                 EXPERIMENTS, Collections.singletonMap(PROJECT_ID, projectId), GetExperimentsResponse.class);
     }
 
+    Single<GetExperimentsResponse> getAllExperiments(String projectName, String workspaceName) {
+        HashMap<QueryParamName, String> params = new HashMap<>();
+        params.put(WORKSPACE_NAME, workspaceName);
+        params.put(PROJECT_NAME, projectName);
+        return singleFromSyncGetWithRetries(EXPERIMENTS, params, GetExperimentsResponse.class);
+    }
+
     Single<ExperimentMetadataRest> getMetadata(String experimentKey) {
         return singleFromSyncGetWithRetries(GET_METADATA, experimentKey, ExperimentMetadataRest.class);
     }

comet-java-client/src/main/java/ml/comet/experiment/impl/constants/QueryParamName.java

@@ -20,6 +20,7 @@ public enum QueryParamName {
     OVERWRITE("overwrite"), // boolean
     PROJECT_ID("projectId"), // string
     WORKSPACE_NAME("workspaceName"), // string
+    PROJECT_NAME("projectName"), // string
 
     WORKSPACE("workspace"), // string
     PROJECT("project"), // string