Remove single value predictions and merge ml and dl

Author: m-mohr

CHANGELOG.md

@@ -18,7 +18,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - `ml_fit_class_random_forest`
     - `ml_fit_regr_random_forest`
     - `ml_predict`
-    - `ml_predict_probabilities`
     - `save_ml_model`
     - `unflatten_dimension`
     - `vector_buffer`

proposals/dl_predict.json

@@ -1,7 +1,7 @@
 {
     "id": "ml_predict",
-    "summary": "Predict classification or regression values using ML",
-    "description": "Applies a machine learning model to a data cube of input features and predicts output values or classes for it.",
+    "summary": "Predict using ML",
+    "description": "Applies a machine learning model to a data cube of input features and returns the predicted values.",
     "categories": [
         "machine learning"
     ],
@@ -17,30 +17,34 @@
         },
         {
             "name": "model",
-            "description": "A ML model that was trained with one of the ML training processes such as ``ml_fit_class_random_forest()``.",
+            "description": "A ML model that was trained with one of the ML training processes such as ``ml_fit_regr_random_forest()``.",
             "schema": {
                 "type": "object",
                 "subtype": "ml-model"
             }
         },
         {
-            "name": "dimension",
-            "description": "The name of the dimension that the model applies to. Fails with a `DimensionNotAvailable` exception if the specified dimension does not exist.",
+            "name": "dimensions",
+            "description": "One or more dimensions to apply the model to. The dimensions may get removed depending on the model. Fails with a `DimensionNotAvailable` exception if one of the specified dimensions does not exist.",
             "schema": {
-                "type": "string"
+                "type": "array",
+                "minItems": 1,
+                "items": {
+                    "type": "string"
+                }
             }
         }
     ],
     "returns": {
-        "description": "The data cube with the predicted values. It removes the specified dimension.",
+        "description": "A data cube with the predicted values. It removes the specified dimensions and adds new dimension for the predicted values. It has the name `predictions` and is of type `other`. If a single value is returned, the dimension has a single label with name `0`.",
         "schema": {
             "type": "object",
-            "subtype": "datacube"
-        }
-    },
-    "exceptions": {
-        "DimensionNotAvailable": {
-            "message": "A dimension with the specified name does not exist."
+            "subtype": "datacube",
+            "dimensions": [
+                {
+                    "type": "other"
+                }
+            ]
         }
     }
 }