feat: decorator for custom_experiments (#154)

* feat: add OPEN_CATEGORICAL_VARIABLE_TYPE

* test: update to new exception msg

* refactor: isSubDomain method

It was getting long and complex.
Create one function for each domain type that checks if another domain is a sub-domain of a domain of that type.

* chore: simplification

* feat: update open categorical types in entityspace

Since the entityspace is fixed on creation strictly it can't have an open categorical dimension. We convert it to categorical with the values passed which will always be a sub-domain of the experiments open-categorical domain.

* chore: doc strings

* feat: custom_experiments as decorated functions as plugins

Just decorate a python function with @custom_experiments to add it

- No need for YAML
- No need for ado_actuators namespace

* feat: agent interface

* refactor: update optimization_test_functions

To use new decorator

* refactor: update optimization_test_functions

To use new decorator

* refactor: further updates for using decorator

* docs: temporarily change included file

* fix: minor

* fix: can't store function

As it can't be serialized

* feat: enhanced inference of domain

also refactor code into more primitive functions

* test: decoration functions

* docs(website): Update custom experiment docs

* fix: comment for future

* feat: Add ExperimentModuleConf for clarity

* refactor: change parameter name

to output_property_identifiers

* docs(website): improvements

* feat: new module type

* refactor: to new parameter name

* chore: fix import

* chore: typing

* fix: not creating correct model

* fix: incorrect anchor

* fix: Handle exceptions from custom functions

* fix: Handle exceptions from submit()

* chore: spelling

* test: execution of custom experiment

* test: check and infer function properties

* refactor: remove unused methods

* test: check behaviour if optional property given

* fix: Not using reference which may be parameterized

* chore: black

* chore: fix comment

* Apply suggestions from code review

Co-authored-by: Alessandro Pomponio <[email protected]>
Signed-off-by: Michael Johnston <[email protected]>

* refactor: change parameter name

* refactor: reorder parameters

* refactor: reorder parameters

* fix: test

---------

Signed-off-by: Michael Johnston <[email protected]>
Co-authored-by: Alessandro Pomponio <[email protected]>

Author: michael-johnston

.codespellrc

@@ -2,4 +2,4 @@
 skip = toxenv,./examples/pfas-generative-models/data,./website/theme,adorchestrator.egg-info,*.svg,examples/pfas-generative-models/data/GM_Comparison/Transfromer/Sample_0/test_generations.csv
 count =
 quiet-level = 3
-ignore-words-list = ser,Transfromer
+ignore-words-list = ser,Transfromer,discus

examples/optimization_test_functions/custom_experiments/ado_actuators/optimization_test_functions/custom_experiments.yaml

@@ -0,0 +1,81 @@
+# Copyright (c) IBM Corporation
+# SPDX-License-Identifier: MIT
+
+import logging
+import typing
+
+from nevergrad.functions import ArtificialFunction
+
+from orchestrator.modules.actuators.custom_experiments import custom_experiment
+from orchestrator.schema.domain import PropertyDomain, VariableTypeEnum
+from orchestrator.schema.property import (
+    ConstitutiveProperty,
+)
+
+moduleLog = logging.getLogger()
+
+
+# Decorate the python function with @custom_experiment
+# This tells ado
+# - The domains of all your parameters i.e. what are valid values they can take
+# - The name of the output variable
+# - If you use keyword args -> Can extract optional parameters and parameterization
+@custom_experiment(
+    required_properties=[
+        ConstitutiveProperty(
+            identifier="x0",
+            propertyDomain=PropertyDomain(
+                variableType=VariableTypeEnum.CONTINUOUS_VARIABLE_TYPE
+            ),
+        ),
+        ConstitutiveProperty(
+            identifier="x1",
+            propertyDomain=PropertyDomain(
+                variableType=VariableTypeEnum.CONTINUOUS_VARIABLE_TYPE
+            ),
+        ),
+        ConstitutiveProperty(
+            identifier="x2",
+            propertyDomain=PropertyDomain(
+                variableType=VariableTypeEnum.CONTINUOUS_VARIABLE_TYPE
+            ),
+        ),
+    ],
+    optional_properties=[
+        ConstitutiveProperty(
+            identifier="num_blocks",
+            propertyDomain=PropertyDomain(
+                variableType=VariableTypeEnum.DISCRETE_VARIABLE_TYPE,
+                domainRange=[1, 10],
+                interval=1,
+            ),
+        ),
+        ConstitutiveProperty(
+            identifier="name",
+            propertyDomain=PropertyDomain(
+                variableType=VariableTypeEnum.CATEGORICAL_VARIABLE_TYPE,
+                values=["discus", "sphere", "cigar", "griewank", "rosenbrock", "st1"],
+            ),
+        ),
+    ],
+    parameterization={"num_blocks": 1, "name": "rosenbrock"},
+    output_property_identifiers=["function_value"],
+)
+def nevergrad_opt_3d_test_func(
+    x0: float, x1: float, x2: float, name: str, num_blocks: int
+) -> dict[str, typing.Any]:
+
+    import numpy as np
+
+    # Get the function from nevergrad.functions.ArtificialFunction
+    func = ArtificialFunction(
+        name=name,
+        num_blocks=num_blocks,
+        block_dimension=int(3 / num_blocks),
+        translation_factor=0.0,
+    )
+
+    # Call the nevergrad function
+    value = func(np.asarray([x0, x1, x2]))
+
+    return {"function_value": value}

examples/optimization_test_functions/custom_experiments/ado_actuators/optimization_test_functions/optimization_test_functions.py

@@ -13,12 +13,12 @@ dependencies = [
 [tool.hatch.build]
 # Include the full namespace path
 include = [
-    "ado_actuators/optimization_test_functions/**",
+    "optimization_test_functions/**",
 ]
 
 [tool.hatch.build.targets.wheel]
 only-include = [
-    "ado_actuators/optimization_test_functions"
+    "optimization_test_functions"
 ]
 
 [tool.hatch.version]
@@ -32,3 +32,8 @@ fallback-version = "0.0.0"
 tagged-metadata = true
 dirty = true
 bump = true
+
+#Add entry point for custom experiments
+[project.entry-points."ado.custom_experiments"]
+optimization_test_functions = "optimization_test_functions.optimization_test_functions"
+

examples/optimization_test_functions/custom_experiments/ado_actuators/optimization_test_functions/__init__.py renamed to examples/optimization_test_functions/custom_experiments/optimization_test_functions/__init__.py

@@ -59,6 +59,7 @@
 register_template_command(app)
 register_upgrade_command(app)
 register_version_command(app)
+# register_hamilton_command(app)
 
 
 @app.callback()