Merge pull request #62 from comet-ml/CM-2345-delete-registry-model

[CM-2345]: Implement equivalent of API.delete_registry_model

Author: yaricom

comet-examples/src/main/java/ml/comet/examples/RegistryModelExample.java

@@ -203,6 +203,12 @@ record = api.registerModel(updatedModel, experiment.getExperimentKey());
                     newComment, newStages);
             System.out.printf("Model version details was successfully updated for: %s\n", SOME_MODEL_VERSION_UP);
 
+            // delete the registry model
+            //
+            System.out.printf("Deleting registry model '%s/%s'.\n", experiment.getWorkspaceName(), newModelName);
+            api.deleteRegistryModel(newModelName, experiment.getWorkspaceName());
+            System.out.println("Model was successfully deleted.");
+
         } finally {
             PathUtils.deleteDirectory(modelTmpDir);
         }

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

@@ -157,4 +157,12 @@ void updateRegistryModelVersion(String registryName, String workspace, String ve
                                     String comments, List<String> stages);
 
     void updateRegistryModelVersion(String registryName, String workspace, String version, String comments);
+
+    /**
+     * Deletes registered model with given name.
+     *
+     * @param registryName the name of the model.
+     * @param workspace    the name of the model's workspace.
+     */
+    void deleteRegistryModel(String registryName, String workspace);
 }

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

@@ -67,6 +67,7 @@
 import static ml.comet.experiment.impl.resources.LogMessages.DOWNLOADING_REGISTRY_MODEL_TO_FILE;
 import static ml.comet.experiment.impl.resources.LogMessages.EXPERIMENT_HAS_NO_MODELS;
 import static ml.comet.experiment.impl.resources.LogMessages.EXTRACTED_N_REGISTRY_MODEL_FILES;
+import static ml.comet.experiment.impl.resources.LogMessages.FAILED_TO_DELETE_REGISTRY_MODEL;
 import static ml.comet.experiment.impl.resources.LogMessages.FAILED_TO_DOWNLOAD_REGISTRY_MODEL;
 import static ml.comet.experiment.impl.resources.LogMessages.FAILED_TO_FIND_EXPERIMENT_MODEL_BY_NAME;
 import static ml.comet.experiment.impl.resources.LogMessages.FAILED_TO_GET_REGISTRY_MODEL_DETAILS;
@@ -424,6 +425,13 @@ public void updateRegistryModelVersion(String registryName, String workspace, St
         this.updateRegistryModelVersion(registryName, workspace, version, null, null);
     }
 
+    @Override
+    public void deleteRegistryModel(String registryName, String workspace) {
+        RestApiResponse response = this.restApiClient.deleteRegistryModel(registryName, workspace)
+                .blockingGet();
+        this.checkRestApiResponse(response, getString(FAILED_TO_DELETE_REGISTRY_MODEL, registryName, workspace));
+    }
+
     /**
      * Release all resources hold by this instance, such as connection to the Comet server.
      *

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

@@ -77,6 +77,7 @@
 import static ml.comet.experiment.impl.constants.ApiEndpoints.ADD_TAG;
 import static ml.comet.experiment.impl.constants.ApiEndpoints.CREATE_REGISTRY_MODEL;
 import static ml.comet.experiment.impl.constants.ApiEndpoints.CREATE_REGISTRY_MODEL_ITEM;
+import static ml.comet.experiment.impl.constants.ApiEndpoints.DELETE_REGISTRY_MODEL;
 import static ml.comet.experiment.impl.constants.ApiEndpoints.DOWNLOAD_REGISTRY_MODEL;
 import static ml.comet.experiment.impl.constants.ApiEndpoints.EXPERIMENTS;
 import static ml.comet.experiment.impl.constants.ApiEndpoints.GET_ARTIFACT_VERSION_DETAIL;
@@ -115,6 +116,8 @@
 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;
+import static ml.comet.experiment.impl.resources.LogMessages.NO_RESPONSE_RETURNED_BY_REMOTE_ENDPOINT;
+import static ml.comet.experiment.impl.resources.LogMessages.getString;
 import static ml.comet.experiment.impl.utils.RestApiUtils.artifactDownloadAssetParams;
 import static ml.comet.experiment.impl.utils.RestApiUtils.artifactVersionDetailsParams;
 import static ml.comet.experiment.impl.utils.RestApiUtils.artifactVersionFilesParams;
@@ -385,6 +388,13 @@ Single<RestApiResponse> updateRegistryModelVersion(RegistryModelUpdateItemReques
         return singleFromAsyncPost(request, UPDATE_REGISTRY_MODEL_VERSION);
     }
 
+    Single<RestApiResponse> deleteRegistryModel(String modelName, String workspaceName) {
+        Map<QueryParamName, String> queryParams = new HashMap<>();
+        queryParams.put(WORKSPACE_NAME, workspaceName);
+        queryParams.put(MODEL_NAME, modelName);
+        return singleFromSyncGetWithRetries(DELETE_REGISTRY_MODEL, queryParams);
+    }
+
     private Single<RestApiResponse> singleFromAsyncDownload(@NonNull OutputStream output,
                                                             @NonNull String endpoint,
                                                             @NonNull Map<QueryParamName, String> queryParams) {
@@ -489,7 +499,15 @@ private Single<RestApiResponse> singleFromSyncPostWithRetriesEmptyBody(@NonNull
         return this.connection.sendPostWithRetries(JsonUtils.toJson(payload), endpoint, true)
                 .map(body -> Single.just(new RestApiResponse(200, body)))
                 .orElse(Single.error(new CometApiException(
-                        String.format("No response was returned by endpoint: %s", endpoint))));
+                        getString(NO_RESPONSE_RETURNED_BY_REMOTE_ENDPOINT, endpoint))));
+    }
+
+    private Single<RestApiResponse> singleFromSyncGetWithRetries(@NonNull String endpoint,
+                                                                 @NonNull Map<QueryParamName, String> params) {
+        return this.connection.sendGetWithRetries(endpoint, params, true)
+                .map(body -> Single.just(new RestApiResponse(200, body)))
+                .orElse(Single.error(new CometApiException(
+                        getString(NO_RESPONSE_RETURNED_BY_REMOTE_ENDPOINT, endpoint))));
     }
 
     private <T> Single<T> singleFromSyncGetWithRetries(@NonNull String endpoint,

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

@@ -28,6 +28,7 @@ public final class ApiEndpoints {
     public static final String UPDATE_REGISTRY_MODEL_NOTES = UPDATE_API_URL + "/registry-model/notes";
     public static final String UPDATE_REGISTRY_MODEL = UPDATE_API_URL + "/registry-model/update";
     public static final String UPDATE_REGISTRY_MODEL_VERSION = UPDATE_API_URL + "/registry-model/item/update";
+    public static final String DELETE_REGISTRY_MODEL = UPDATE_API_URL + "/registry-model/delete";
 
     public static final String READ_API_URL = "/api/rest/v2";
     public static final String GET_ASSETS_LIST = READ_API_URL + "/experiment/asset/list";

comet-java-client/src/main/java/ml/comet/experiment/impl/resources/LogMessages.java

@@ -97,6 +97,8 @@ public class LogMessages {
     public static final String FAILED_TO_UPDATE_REGISTRY_MODEL = "FAILED_TO_UPDATE_REGISTRY_MODEL";
     public static final String FAILED_TO_UPDATE_REGISTRY_MODEL_VERSION = "FAILED_TO_UPDATE_REGISTRY_MODEL_VERSION";
     public static final String REGISTRY_MODEL_VERSION_NOT_FOUND = "REGISTRY_MODEL_VERSION_NOT_FOUND";
+    public static final String FAILED_TO_DELETE_REGISTRY_MODEL = "FAILED_TO_DELETE_REGISTRY_MODEL";
+    public static final String NO_RESPONSE_RETURNED_BY_REMOTE_ENDPOINT = "NO_RESPONSE_RETURNED_BY_REMOTE_ENDPOINT";
 
 
     /**

comet-java-client/src/main/resources/messages.properties

@@ -82,3 +82,5 @@ FAILED_TO_UPDATE_REGISTRY_MODEL_NOTES=Failed to update notes of the registry mod
 FAILED_TO_UPDATE_REGISTRY_MODEL=Failed to update registry model '%s/%s' with data: '%s'.
 FAILED_TO_UPDATE_REGISTRY_MODEL_VERSION=Failed to update registry model's version '%s/%s:%s' with data: '%s'.
 REGISTRY_MODEL_VERSION_NOT_FOUND=Version '%s' of the registry model '%s/%s' is not found.
+FAILED_TO_DELETE_REGISTRY_MODEL=Failed to delete registry model '%s/%s'.
+NO_RESPONSE_RETURNED_BY_REMOTE_ENDPOINT=No response was returned by endpoint '%s'

comet-java-client/src/test/java/ml/comet/experiment/impl/CometApiTest.java

@@ -550,6 +550,34 @@ public void testUpdateRegistryModelVersion() {
         assertEquals(stages, versionOverview.getStages(), "wrong stages");
     }
 
+    @Test
+    public void testDeleteRegistryModel() {
+        String modelName = String.format("%s-%d", SOME_MODEL_NAME, System.currentTimeMillis());
+
+        // register model with defaults
+        //
+        registerModelWithDefaults(modelName);
+
+        // wait for registry model to be processed by backend
+        //
+        Awaitility.await("failed to get registry model")
+                .pollInterval(1, TimeUnit.SECONDS)
+                .atMost(60, TimeUnit.SECONDS)
+                .until(() -> COMET_API.getRegistryModelDetails(modelName,
+                        SHARED_EXPERIMENT.getWorkspaceName()).isPresent());
+
+        // try to delete the model
+        //
+        COMET_API.deleteRegistryModel(modelName, SHARED_EXPERIMENT.getWorkspaceName());
+    }
+
+    @Test
+    public void testDeleteRegistryModel_doesnt_exists() {
+        String modelName = "not existing model";
+        assertThrows(CometApiException.class, () ->
+                COMET_API.deleteRegistryModel(modelName, SHARED_EXPERIMENT.getWorkspaceName()));
+    }
+
     private static String registerModelWithDefaults(String modelName) {
         // log model folder
         //