stuff

Author: jacobdenobel

docs/source/conf.py

@@ -12,13 +12,14 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../..'))
+
+sys.path.insert(0, os.path.abspath("../.."))
 
 # -- Project information -----------------------------------------------------
 
-project = 'modcma'
-copyright = '2020, Jacob de Nobel'
-author = 'Jacob de Nobel'
+project = "modcma"
+copyright = "2020, Jacob de Nobel"
+author = "Jacob de Nobel"
 
 
 # -- General configuration ---------------------------------------------------
@@ -27,21 +28,21 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.coverage',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.autosummary',
-    'sphinx_automodapi.automodapi',
-    'sphinx.ext.graphviz',
-    'sphinx_automodapi.smart_resolver',
-    'sphinx.ext.intersphinx',
-    'sphinx_rtd_theme',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autosummary",
+    "sphinx_automodapi.automodapi",
+    "sphinx.ext.graphviz",
+    "sphinx_automodapi.smart_resolver",
+    "sphinx.ext.intersphinx",
+    "sphinx_rtd_theme",
 ]
 # numpydoc_show_class_members = False
-master_doc = 'index'
+master_doc = "index"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -54,28 +55,27 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 # html_static_path = ['_static']
 
-github_url=  'https://github.com/IOHprofiler/ModularCMAES'
+github_url = "https://github.com/IOHprofiler/ModularCMAES"
 html_theme_options = {
-    'canonical_url': '',
-   
+    "canonical_url": "",
     # 'analytics_id': 'UA-XXXXXXX-1',  #  Provided by Google in your dashboard
-    'logo_only': False,
-    'display_version': True,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
+    "logo_only": False,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
     # 'vcs_pageview_mode': '',
     # 'style_nav_header_background': 'white',
     # Toc options
-    'collapse_navigation': False,
-    'sticky_navigation': False,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    "collapse_navigation": False,
+    "sticky_navigation": False,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
 }

modcma/__main__.py

@@ -4,7 +4,6 @@
 
 from .modularcmaes import evaluate_bbob
 
-
 parser = ArgumentParser(description="Run single function CMAES")
 parser.add_argument(
     "-f", "--fid", type=int, help="bbob function id", required=False, default=5
@@ -27,12 +26,8 @@
 parser.add_argument("-s", "--seed", type=int, required=False, default=42)
 parser.add_argument("-p", "--data_folder", type=str, required=False)
 parser.add_argument("-a", "--arguments", nargs="+", required=False)
-parser.add_argument(
-    "-c", "--cpp", required=False, action="store_true", default=False
-)
-parser.add_argument(
-    "--plot", required=False, action="store_true", default=False
-)
+parser.add_argument("-c", "--cpp", required=False, action="store_true", default=False)
+parser.add_argument("--plot", required=False, action="store_true", default=False)
 
 args = vars(parser.parse_args())
 for arg in args.pop("arguments") or []:

modcma/asktellcmaes.py

@@ -1,4 +1,5 @@
 """Ask and tell interface to the Modular CMA-ES."""
+
 import warnings
 import typing
 from collections import deque
@@ -23,6 +24,7 @@ def check_break_conditions(f: typing.Callable) -> typing.Callable:
         When any(~AskTellCMAES.break_conditions) == True
 
     """
+
     @wraps(f)
     def inner(self, *args, **kwargs) -> typing.Any:
         if any(self.break_conditions):
@@ -140,7 +142,7 @@ def tell(self, xi: np.ndarray, fi: float) -> None:
             When the same xi is provided more than once
 
         """
-        #pylint: disable=singleton-comparison
+        # pylint: disable=singleton-comparison
         if not self.parameters.population:
             raise RuntimeError("Call to tell without calling ask first is prohibited")
 
@@ -149,15 +151,17 @@ def tell(self, xi: np.ndarray, fi: float) -> None:
             raise ValueError("Unkown xi provided")
 
         for index in indices:
-            if self.parameters.population.f[index] == None: # noqa
+            if self.parameters.population.f[index] == None:  # noqa
                 self.parameters.population.f[index] = fi
                 break
         else:
             warnings.warn("Repeated call to tell with same xi", UserWarning)
             self.parameters.population.f[index] = fi
 
         self.parameters.used_budget += 1
-        if len(self.ask_queue) == 0 and (self.parameters.population.f != None).all(): # noqa
+        if (
+            len(self.ask_queue) == 0 and (self.parameters.population.f != None).all()
+        ):  # noqa
             self.select()
             self.recombine()
             self.parameters.adapt()

modcma/c_maes/__init__.py

@@ -30,7 +30,7 @@
     es,  # pyright: ignore[reportMissingModuleSource]
 )
 
-from .cmaescpp.parameters import ( # pyright: ignore[reportMissingModuleSource]
+from .cmaescpp.parameters import (  # pyright: ignore[reportMissingModuleSource]
     Settings,
     Modules,
 )  # pyright: ignore[reportMissingModuleSource]
@@ -47,8 +47,7 @@ def _get_module_options(name: str) -> tuple:
     module_class = default_value.__class__
     if issubclass(module_class, Enum):
         other_values = [
-            x.name for x in module_class.__members__.values() 
-            if x is not default_value
+            x.name for x in module_class.__members__.values() if x is not default_value
         ]
         return tuple([default_value.name] + other_values)
     raise TypeError(f"{name} has a unparsable type {type(default_value)}")
@@ -85,10 +84,10 @@ def _make_numeric_parameter(
 
 
 def get_configspace(
-    dim: int = None, 
-    add_popsize: bool = True, 
-    add_sigma: bool = True, 
-    add_learning_rates: bool = True
+    dim: int = None,
+    add_popsize: bool = True,
+    add_sigma: bool = True,
+    add_learning_rates: bool = True,
 ) -> ConfigurationSpace:
     cspace = ConfigurationSpace()
     for name, options in get_all_module_options().items():
@@ -105,17 +104,17 @@ def get_configspace(
         cspace.add(_make_numeric_parameter("lambda0", dim, 1, 50 * dim))
         cspace.add(_make_numeric_parameter("mu0", dim, 1, 50 * dim))
         cspace.add(ForbiddenGreaterThanRelation(cspace["mu0"], cspace["lambda0"]))
-    
+
     if add_sigma:
         cspace.add(_make_numeric_parameter("sigma0", dim, 1e-15, 1e15))
-    
+
     if add_learning_rates:
         cspace.add(_make_numeric_parameter("cs", dim, 0, 1.0))
         cspace.add(_make_numeric_parameter("cc", dim, 0, 1.0))
         cspace.add(_make_numeric_parameter("cmu", dim, 0, 1.0))
         cspace.add(_make_numeric_parameter("c1", dim, 0, 1.0))
         cspace.add(_make_numeric_parameter("damps", dim, 0, 10.0))
-        
+
     return cspace
 
 
@@ -126,7 +125,7 @@ def set_module(modules: Modules, name: str, value: Enum) -> bool:
             value = getattr(attr_class, value)
         setattr(modules, name, value)
         return True
-    return False    
+    return False
 
 
 def settings_from_dict(dim: int, **config: dict) -> Settings:
@@ -140,11 +139,7 @@ def settings_from_dict(dim: int, **config: dict) -> Settings:
     return settings
 
 
-def settings_from_config(
-    dim: int, 
-    config: Configuration, 
-    **kwargs
-) -> Settings:
+def settings_from_config(dim: int, config: Configuration, **kwargs) -> Settings:
     via_settings = kwargs
     default_config = get_configspace(dim).get_default_configuration()
     modules = Modules()
@@ -157,14 +152,15 @@ def settings_from_config(
     settings = Settings(dim, modules, **via_settings)
     return settings
 
+
 def fmin(func: callable, x0: np.ndarray, sigma0: float, budget: int, **kwargs):
     """Minimize a function using the modular CMA-ES.
 
     Parameters
     ----------
     func: callable
         The objective function to be minimized.
-    x0 np.ndarray: 
+    x0 np.ndarray:
         The first solution estimate
     sigma0: float
         The estimate of the stepsize (rule of thumb: 0.3 * (ub - lb))
@@ -187,9 +183,15 @@ def fmin(func: callable, x0: np.ndarray, sigma0: float, budget: int, **kwargs):
     settings = settings_from_dict(len(x0), sigma0=sigma0, budget=budget, **kwargs)
     es = ModularCMAES(settings)
     es(func)
-    
-    return es.p.stats.global_best.x, es.p.stats.global_best.y, es.p.stats.evaluations, es
-    
+
+    return (
+        es.p.stats.global_best.x,
+        es.p.stats.global_best.y,
+        es.p.stats.evaluations,
+        es,
+    )
+
+
 __all__ = (
     "settings_from_config",
     "get_configspace",

modcma/c_maes/cmaescpp/__init__.pyi

@@ -24,8 +24,6 @@ class constants:
     clip_sigma: ClassVar[bool] = ...
     def __init__(self, *args, **kwargs) -> None: ...
 
-
-
 class Population:
     X: numpy.ndarray
     Y: numpy.ndarray
@@ -89,7 +87,7 @@ class Parameters:
     def start(
         self, objective: Callable[[numpy.ndarray[numpy.float64[m, 1]]], float]
     ) -> None: ...
-    
+
 class ModularCMAES:
     @overload
     def __init__(self, parameters: Parameters) -> None: ...

modcma/c_maes/cmaescpp/es.pyi

@@ -26,7 +26,15 @@ class MuCommaLambdaES:
     tau: float
     tau_i: float
     x_min: numpy.ndarray
-    def __init__(self, d: int, x0: numpy.ndarray, sigma0: float = ..., budget: int = ..., target: float = ..., modules: modcma.c_maes.cmaescpp.parameters.Modules = ...) -> None: ...
+    def __init__(
+        self,
+        d: int,
+        x0: numpy.ndarray,
+        sigma0: float = ...,
+        budget: int = ...,
+        target: float = ...,
+        modules: modcma.c_maes.cmaescpp.parameters.Modules = ...,
+    ) -> None: ...
     def sample(self, arg0: numpy.ndarray) -> numpy.ndarray: ...
     def step(self, arg0: Callable[[numpy.ndarray], float]) -> None: ...
     def __call__(self, arg0: Callable[[numpy.ndarray], float]) -> None: ...
@@ -43,7 +51,16 @@ class OnePlusOneES:
     t: int
     target: float
     x: numpy.ndarray
-    def __init__(self, d: int, x0: numpy.ndarray, f0: float, sigma0: float = ..., budget: int = ..., target: float = ..., modules: modcma.c_maes.cmaescpp.parameters.Modules = ...) -> None: ...
+    def __init__(
+        self,
+        d: int,
+        x0: numpy.ndarray,
+        f0: float,
+        sigma0: float = ...,
+        budget: int = ...,
+        target: float = ...,
+        modules: modcma.c_maes.cmaescpp.parameters.Modules = ...,
+    ) -> None: ...
     def sample(self) -> numpy.ndarray: ...
     def step(self, arg0: Callable[[numpy.ndarray], float]) -> None: ...
     def __call__(self, arg0: Callable[[numpy.ndarray], float]) -> None: ...