WIP

Author: soxofaan

docs/api-processbuilder.rst

@@ -1,5 +1,6 @@
-..  FYI this file is intended to be "included"
-    from the ProcessBuilder class doc block
+..  FYI this file is intended to be inlined (with "include" RST directive)
+    in the ProcessBuilder class doc block,
+    which in turn is covered with autodoc/automodule from api-processes.rst.
 
 
 The :py:class:`ProcessBuilder <openeo.processes.ProcessBuilder>` class
@@ -44,9 +45,9 @@ but some kind of *virtual placeholder*,
 a :py:class:`ProcessBuilder <openeo.processes.ProcessBuilder>` instance,
 that keeps track of the operations you intend to do on the EO data.
 
-To make that more concrete, let's add type hints
-(which will make it easier to discover what we can do with the argument,
-depending on which editor or IDE you are using):
+To make that more concrete, it helps to add type hints
+which will make it easier to discover what you can do with the argument
+(depending on which editor or IDE you are using):
 
 .. code-block:: python
 

docs/api-processes.rst

@@ -63,7 +63,7 @@ and the callback functions match up:
 --------------------------------
 
 ..  FYI the ProcessBuilder docs are provided through its doc block
-    with an "include" of "api-processbuilder.rst"
+    with an RST "include" of "api-processbuilder.rst"
 
 .. automodule:: openeo.processes
     :members: ProcessBuilder

docs/process_mapping.py

@@ -9,6 +9,7 @@
 import datetime
 import sys
 from textwrap import dedent
+import importlib
 
 from openeo.internal.documentation import _process_registry
 
@@ -38,11 +39,14 @@ def main():
             *   - openEO process
                 - openEO Python Client Method
     """))
-
-    import openeo.rest.datacube
-    import openeo.rest.vectorcube
-    import openeo.rest.mlmodel
-    import openeo.processes
+    # Import some submodules to make sure `_process_registry` is populated
+    for mod in [
+        "openeo.rest.datacube",
+        "openeo.rest.vectorcube",
+        "openeo.rest.mlmodel",
+        "openeo.processes",
+    ]:
+        importlib.import_module(mod)
 
     for process_id in sorted(_process_registry.keys()):
         functions = [x[0] for x in _process_registry[process_id]]

openeo/rest/datacube.py

@@ -845,7 +845,7 @@ def aggregate_spatial(
             Parameter,
             VectorCube,
         ],
-        reducer: Union[str, PGNode, typing.Callable],
+        reducer: Union[str, typing.Callable, PGNode],
         target_dimension: Optional[str] = None,
         crs: Optional[str] = None,
         context: Optional[dict] = None,
@@ -857,7 +857,20 @@ def aggregate_spatial(
 
         :param geometries: a shapely geometry, a GeoJSON-style dictionary,
             a public GeoJSON URL, or a path (that is valid for the back-end) to a GeoJSON file.
-        :param reducer: a callback function that creates a process graph, see :ref:`callbackfunctions`
+        :param reducer: the "child callback":
+            the name of a single openEO process,
+            or a callback function as discussed in :ref:`callbackfunctions`,
+            or a :py:class:`UDF <openeo.rest._datacube.UDF>` instance.
+
+            The callback should correspond to a process that
+            receives an array of numerical values
+            and returns a single numerical value.
+            For example:
+
+            -   ``"mean"`` (string)
+            -   :py:func:`absolute <openeo.processes.max>` (:ref:`predefined openEO process function <openeo_processes_functions>`)
+            -   ``lambda data: data.min()`` (function or lambda)
+
         :param target_dimension: The new dimension name to be used for storing the results.
         :param crs: The spatial reference system of the provided polygon.
             By default longitude-latitude (EPSG:4326) is assumed.
@@ -1323,12 +1336,12 @@ def count_time(self) -> "DataCube":
 
     @openeo_process
     def aggregate_temporal(
-            self,
-            intervals: List[list],
-            reducer: Union[str, PGNode, typing.Callable],
-            labels: Optional[List[str]] = None,
-            dimension: Optional[str] = None,
-            context: Optional[dict] = None,
+        self,
+        intervals: List[list],
+        reducer: Union[str, typing.Callable, PGNode],
+        labels: Optional[List[str]] = None,
+        dimension: Optional[str] = None,
+        context: Optional[dict] = None,
     ) -> "DataCube":
         """
         Computes a temporal aggregation based on an array of date and/or time intervals.
@@ -1338,7 +1351,20 @@ def aggregate_temporal(
         If the dimension is not set, the data cube is expected to only have one temporal dimension.
 
         :param intervals: Temporal left-closed intervals so that the start time is contained, but not the end time.
-        :param reducer: A reducer to be applied on all values along the specified dimension. The reducer must be a callable process (or a set processes) that accepts an array and computes a single return value of the same type as the input values, for example median.
+        :param reducer: the "child callback":
+            the name of a single openEO process,
+            or a callback function as discussed in :ref:`callbackfunctions`,
+            or a :py:class:`UDF <openeo.rest._datacube.UDF>` instance.
+
+            The callback should correspond to a process that
+            receives an array of numerical values
+            and returns a single numerical value.
+            For example:
+
+            -   ``"mean"`` (string)
+            -   :py:func:`absolute <openeo.processes.max>` (:ref:`predefined openEO process function <openeo_processes_functions>`)
+            -   ``lambda data: data.min()`` (function or lambda)
+
         :param labels: Labels for the intervals. The number of labels and the number of groups need to be equal.
         :param dimension: The temporal dimension for aggregation. All data along the dimension will be passed through the specified reducer. If the dimension is not set, the data cube is expected to only have one temporal dimension.
         :param context: Additional data to be passed to the reducer. Not set by default.