Move advanced design space handling in separate `smt-design-space-ext…

…` module (#651)

* add notebook

* update design space utils

* ruff'

* add adsg 1.1.1

* fix setup

.coveragerc

@@ -11,4 +11,4 @@ omit =
 	*/tests/*
 	*/examples/*
 	*/__init__.py
-	*/setup.py
+	*/setup.py

.github/workflows/tests_coverage.yml

@@ -27,7 +27,7 @@ jobs:
     - name: Install dependencies
       run: |
         pip install --upgrade pip
-        pip install -r requirements.txt numpy==1.26.4 ConfigSpace==0.6.1
+        pip install -r requirements.txt numpy==1.26.4 ConfigSpace==0.6.1 adsg-core==1.1.1 git+https://github.com/SMTorg/smt-design-space-ext
         pip list
         pip install -e .
 

requirements.txt

@@ -10,4 +10,4 @@ pytest-xdist    # allows running parallel testing with pytest -n <num_workers>
 pytest-cov      # allows to get coverage report
 ruff            # format and lint code
 jenn >= 1.0.2, <2.0
-egobox ~= 0.20.0
+egobox ~= 0.20.0

setup.py

@@ -107,6 +107,8 @@
         "smt.sampling_methods",
         "smt.utils",
         "smt.applications",
+        "smt.design_space",
+        "smt.kernels",
     ],
     install_requires=[
         "scikit-learn",
@@ -118,9 +120,6 @@
         "numba": [  # pip install smt[numba]
             "numba~=0.56.4",
         ],
-        "cs": [  # pip install smt[cs]
-            "ConfigSpace~=0.6.1",
-        ],
         "gpx": ["egobox~=0.22"],  # pip install smt[gpx]
     },
     python_requires=">=3.9",

smt/__init__.py

@@ -1 +1,14 @@
 __version__ = "2.7.0"
+
+__all__ = [
+    "surrogate_models",
+    "kernels",
+    "design_space",
+    "applications",
+    "examples",
+    "sampling_methods",
+    "utils",
+    "tests",
+    "src",
+    "problems",
+]

smt/applications/ego.py

@@ -19,10 +19,7 @@
 )
 from smt.sampling_methods import LHS
 from smt.surrogate_models import GEKPLS, GPX, KPLS, KPLSK, KRG, MGP
-from smt.utils.design_space import (
-    BaseDesignSpace,
-    DesignSpace,
-)
+from smt.design_space import BaseDesignSpace, DesignSpace
 
 
 class Evaluator(object):

smt/applications/mfk.py

@@ -23,7 +23,7 @@
     MixIntKernelType,
     compute_n_param,
 )
-from smt.utils.design_space import ensure_design_space
+from smt.design_space import ensure_design_space
 from smt.utils.kriging import (
     componentwise_distance,
     compute_X_cont,

smt/applications/mixed_integer.py

@@ -12,7 +12,8 @@
 from smt.surrogate_models.krg_based import KrgBased, MixIntKernelType
 from smt.surrogate_models.surrogate_model import SurrogateModel
 from smt.utils.checks import ensure_2d_array
-from smt.utils.design_space import (
+
+from smt.design_space import (
     BaseDesignSpace,
     CategoricalVariable,
     ensure_design_space,

smt/applications/tests/test_ego.py

@@ -11,7 +11,7 @@
 
 import numpy as np
 
-import smt.utils.design_space as ds
+import smt.design_space as ds
 from smt.applications import EGO
 from smt.applications.ego import Evaluator
 from smt.applications.mixed_integer import (

smt/applications/tests/test_mfk_mfkpls_mixed.py

@@ -32,9 +32,9 @@
     KRG,
     MixIntKernelType,
 )
-from smt.utils.design_space import (
-    CategoricalVariable,
+from smt.design_space import (
     DesignSpace,
+    CategoricalVariable,
     FloatVariable,
     IntegerVariable,
 )

smt/applications/tests/test_mixed_integer.py

@@ -17,7 +17,16 @@
 except ImportError:
     NO_MATPLOTLIB = True
 
-import smt.utils.design_space as ds
+import smt.design_space as ds
+from smt.design_space import (
+    HAS_CONFIG_SPACE,
+    DesignSpace,
+    CategoricalVariable,
+    FloatVariable,
+    IntegerVariable,
+    OrdinalVariable,
+)
+
 from smt.applications.mixed_integer import (
     MixedIntegerContext,
     MixedIntegerKrigingModel,
@@ -33,14 +42,6 @@
     MixHrcKernelType,
     MixIntKernelType,
 )
-from smt.utils.design_space import (
-    HAS_CONFIG_SPACE,
-    CategoricalVariable,
-    DesignSpace,
-    FloatVariable,
-    IntegerVariable,
-    OrdinalVariable,
-)
 
 
 class TestMixedInteger(unittest.TestCase):
@@ -474,10 +475,10 @@ def run_mixed_integer_lhs_example(self):
 
         from smt.applications.mixed_integer import MixedIntegerSamplingMethod
         from smt.sampling_methods import LHS
-        from smt.utils.design_space import (
-            CategoricalVariable,
-            DesignSpace,
+        from smt.design_space import (
             FloatVariable,
+            DesignSpace,
+            CategoricalVariable,
         )
 
         float_var = FloatVariable(0, 4)
@@ -507,7 +508,7 @@ def run_mixed_integer_qp_example(self):
 
         from smt.applications.mixed_integer import MixedIntegerSurrogateModel
         from smt.surrogate_models import QP
-        from smt.utils.design_space import DesignSpace, IntegerVariable
+        from smt.design_space import DesignSpace, IntegerVariable
 
         xt = np.array([0.0, 1.0, 2.0, 3.0, 4.0])
         yt = np.array([0.0, 1.0, 1.5, 0.5, 1.0])
@@ -539,7 +540,7 @@ def run_mixed_integer_context_example(self):
 
         from smt.applications.mixed_integer import MixedIntegerContext
         from smt.surrogate_models import KRG
-        from smt.utils.design_space import (
+        from smt.design_space import (
             CategoricalVariable,
             DesignSpace,
             FloatVariable,
@@ -747,7 +748,7 @@ def run_mixed_discrete_design_space_example(self):
 
         from smt.applications.mixed_integer import MixedIntegerSamplingMethod
         from smt.sampling_methods import LHS
-        from smt.utils.design_space import (
+        from smt.design_space import (
             CategoricalVariable,
             DesignSpace,
             FloatVariable,
@@ -798,7 +799,7 @@ def run_hierarchical_design_space_example(self):
         )
         from smt.sampling_methods import LHS
         from smt.surrogate_models import KRG, MixHrcKernelType, MixIntKernelType
-        from smt.utils.design_space import (
+        from smt.design_space import (
             CategoricalVariable,
             DesignSpace,
             FloatVariable,
@@ -1099,7 +1100,7 @@ def run_hierarchical_variables_Goldstein(self):
         )
         from smt.sampling_methods import LHS
         from smt.surrogate_models import KRG, MixHrcKernelType, MixIntKernelType
-        from smt.utils.design_space import (
+        from smt.design_space import (
             CategoricalVariable,
             DesignSpace,
             FloatVariable,
@@ -2005,7 +2006,7 @@ def run_mixed_gower_example(self):
             MixedIntegerKrigingModel,
         )
         from smt.surrogate_models import KRG, MixIntKernelType
-        from smt.utils.design_space import (
+        from smt.design_space import (
             CategoricalVariable,
             DesignSpace,
             FloatVariable,
@@ -2136,7 +2137,7 @@ def run_mixed_cs_example(self):
             MixedIntegerKrigingModel,
         )
         from smt.surrogate_models import KRG, MixIntKernelType
-        from smt.utils.design_space import (
+        from smt.design_space import (
             CategoricalVariable,
             DesignSpace,
             FloatVariable,
@@ -2265,7 +2266,7 @@ def run_mixed_homo_gaussian_example(self):
 
         from smt.applications.mixed_integer import MixedIntegerKrigingModel
         from smt.surrogate_models import KRG, MixIntKernelType
-        from smt.utils.design_space import (
+        from smt.design_space import (
             CategoricalVariable,
             DesignSpace,
             FloatVariable,
@@ -2394,7 +2395,7 @@ def run_mixed_homo_hyp_example(self):
 
         from smt.applications.mixed_integer import MixedIntegerKrigingModel
         from smt.surrogate_models import KRG, MixIntKernelType
-        from smt.utils.design_space import (
+        from smt.design_space import (
             CategoricalVariable,
             DesignSpace,
             FloatVariable,

smt/design_space/__init__.py

@@ -0,0 +1,55 @@
+import importlib
+
+spec = importlib.util.find_spec("smt_design_space")
+if spec:
+    HAS_DESIGN_SPACE_EXT = True
+    HAS_CONFIG_SPACE = True
+    HAS_ADSG = True
+else:
+    HAS_DESIGN_SPACE_EXT = False
+    HAS_CONFIG_SPACE = False
+    HAS_ADSG = False
+
+
+if HAS_DESIGN_SPACE_EXT:
+    from smt_design_space.design_space import (
+        CategoricalVariable,
+        DesignSpace,
+        BaseDesignSpace,
+        FloatVariable,
+        IntegerVariable,
+        OrdinalVariable,
+        ensure_design_space,
+    )
+
+else:
+    from smt.design_space.design_space import (
+        CategoricalVariable,
+        DesignSpace,
+        FloatVariable,
+        IntegerVariable,
+        OrdinalVariable,
+        ensure_design_space,
+        BaseDesignSpace,
+    )
+
+if HAS_DESIGN_SPACE_EXT:
+    from smt_design_space.design_space import DesignSpaceGraph
+else:
+
+    class DesignSpaceGraph:
+        pass
+
+
+__all__ = [
+    "HAS_DESIGN_SPACE_EXT",
+    "HAS_CONFIG_SPACE",
+    "HAS_ADSG",
+    "BaseDesignSpace",
+    "DesignSpace",
+    "FloatVariable",
+    "IntegerVariable",
+    "OrdinalVariable",
+    "CategoricalVariable",
+    "ensure_design_space",
+]