coco-experiment 2.7.2__tar.gz → 2.7.4__tar.gz

{coco_experiment-2.7.2 → coco_experiment-2.7.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: coco-experiment
-Version: 2.7.2
+Version: 2.7.4
 Summary: Benchmarking framework for all types of black-box optimization algorithms.
 Project-URL: Homepage, https://github.com/numbbo/coco-experiment
 Project-URL: Documentation, https://numbbo.github.io/coco-doc/apidocs/cocoex/

{coco_experiment-2.7.2 → coco_experiment-2.7.4}/meson.build

@@ -64,6 +64,7 @@ dep_numpy = declare_dependency(include_directories: inc_numpy, compile_args: cfl
 python_sources = [
   'src/cocoex/__init__.py',
   'src/cocoex/_version.py',
+  'src/cocoex/download_example.py',
   'src/cocoex/exceptions.py',
   'src/cocoex/noiser.py',
   'src/cocoex/solvers.py',

{coco_experiment-2.7.2 → coco_experiment-2.7.4}/src/cocoex/_version.py

@@ -1,7 +1,7 @@
 # file generated by fabricate
 # Do not change, do not track in version control!
 
-__version__ = "2.7.2"
+__version__ = "2.7.4"
 version = __version__
 
 if __name__ == "__main__":

{coco_experiment-2.7.2 → coco_experiment-2.7.4}/src/cocoex/coco.c

@@ -31526,7 +31526,7 @@ void coco_archive_free(coco_archive_t *archive) {
  * don't change, don't track in version control!
  */
 
-const char *coco_version = "2.7.2";
+const char *coco_version = "2.7.4";
 #line 1 "coco_runtime_c.c"
 /**
  * @file coco_runtime_c.c

coco_experiment-2.7.4/src/cocoex/download_example.py

@@ -0,0 +1,45 @@
+"""Download example scripts from GitHub to a local folder, by default `cocoex-example`
+in the current folder.
+
+Usage::
+
+    python -m cocoex.download_example [folder_name]
+
+"""
+import os
+import sys
+
+default_local_folder = 'cocoex-example'
+
+remote_folder = 'https://raw.githubusercontent.com/numbbo/coco-experiment/main/build/python/example/'
+
+file_names = ['mkl_bugfix.py', 
+        'example_experiment_simple.py',
+        'example_experiment_complete.py',
+        'example_experiment_non_anytime.py',
+        'example_experiment_parameter_sweep.py',
+        ]
+
+def main(folder=None):
+    """download example scripts from GitHub into `folder`, by default `./cocoex-example`"""
+    try:
+        import urllib.request
+    except ImportError:
+        print('Install urllib (`pip install urllib`) to download example')
+        raise
+    if folder is None:
+        folder = default_local_folder
+    if os.path.exists(folder):
+        raise ValueError('local target folder {0} already exists. Remove the folder\n'
+                         'or pass another folder name as argument to `cocoex.download_example`'
+                         .format(folder))
+    os.mkdir(folder)
+    for file_name in file_names:
+        with urllib.request.urlopen(remote_folder + file_name) as f:
+            d = f.read().decode('utf-8')
+        with open(folder + '/' + file_name, 'w') as f:
+            f.write(d)
+    print('  example scripts have been downloaded to {0}'.format(folder))
+
+if __name__ == '__main__':
+    main(sys.argv[1] if len(sys.argv) > 1 else None)

{coco_experiment-2.7.2 → coco_experiment-2.7.4}/src/cocoex/noiser.py

@@ -70,7 +70,8 @@ class Noisifier:
     noise generator and the numbers scaled by pi/2 such that P(number > k)
     equals about 1/k when k >= 5.
 
-    See also https://github.com/numbbo/coco-experiment/blob/main/build/python/example/example_experiment_complete.py
+    See also https://github.com/numbbo/coco-experiment/issues/36 and
+    https://github.com/numbbo/coco-experiment/blob/main/build/python/example/example_experiment_complete.py
 
     """
     def __init__(self, p_add=0.2, p_subtract=0.0, p_epsilon=0, epsilon=1e-4,

{coco_experiment-2.7.2 → coco_experiment-2.7.4}/src/cocoex/utilities.py

@@ -647,8 +647,9 @@ class ExperimentRepeater:
     When problem instances are repeated in a single suite, they may be
     *partially* skipped *after* the first full sweep. That is, the
     configuration ``1-5,1-5,1-5`` can also lead to four trials of each
-    instance 1-5, because all instances have been repeated the same number
-    of times.
+    instance 1-5 of some problems when all instances have been repeated the
+    same number of times and have enough successes or the budget is
+    exhaused.
 
     >>> import cocoex  # some not very meaningful testing
     >>> repeater = cocoex.ExperimentRepeater(2)
@@ -658,18 +659,31 @@ class ExperimentRepeater:
     >>> assert len(repeater.evaluations((1, 2))) == 0
 
     """
-    def __init__(self, budget_multiplier, min_successes=None):
-        """``min_successes=11`` is default and provokes at least three
-
-        sweeps when the suite has (only) 5 instance and the
-        `budget_multiplier` is large enough such that the algorithm
-        terminates the second sweep before the overall budget is exhausted.
-        This would emulate the 3 x 1-5 instance-setup from BBOB 2009,
-        however the choice of the initial solution still slightly differs.
+    min_successes_default = 11
+    max_sweeps_default = 20
+    def __init__(self, budget_multiplier, min_successes=None, max_sweeps=None):
+        """constructor for `ExperimentRepeater`.
+
+        The "timeout" budget is computed as ``budget_multiplier`` times
+        problem dimension.
+
+        ``min_successes=11`` is default and provokes at least three sweeps
+        when the suite has (only) 5 instance and the `budget_multiplier` is
+        large enough such that the algorithm terminates the second sweep
+        before the overall budget is exhausted. This would emulate the 3 x
+        1-5 instance-setup from BBOB 2009, however the choice of the
+        initial solution still slightly differs.
+
+        ``max_sweeps`` is the limit number of repititions for each
+        instance, by default 20. To have a limit is in particular useful
+        when the budget is large but an algorithm terminates very quickly
+        and invariably unsuccessfully.
         """
         self.params = {k: v for k, v in locals().items() if k != 'self'}
-        self.min_successes = 11 if min_successes is None else min_successes
-        self.max_sweeps = 1e4  # should not be necessary
+        self.min_successes = ExperimentRepeater.min_successes_default if (
+                min_successes is None) else min_successes
+        self.max_sweeps = ExperimentRepeater.max_sweeps_default if (
+                max_sweeps is None) else max_sweeps  # useful on F7
         self._dimension_offset = 0
         '''budget = (dimension + offset) * budget_multiplier'''
         self._data = _collections.OrderedDict()
@@ -728,7 +742,13 @@ class ExperimentRepeater:
             return sum(self.trials(problem))
         return sum(self.all(self.n_trials).values())
     def track(self, problem):
-        """record problem instance evaluations and success (target hit)"""
+        """record problem instance evaluations and success (final target hit).
+
+        Track data to decide (later) whether more experiments or sweeps are
+        needed. `track` requires `problem` to have the attributes
+        ``id_function, dimension, id_instance, evaluations`` and
+        ``final_target_hit``.
+        """
         fun, dim, iinst = self.problem_to_ids(problem)
         if (fun, dim) not in self._data:
             self._data[(fun, dim)] = _collections.defaultdict(list)
@@ -848,7 +868,7 @@ class ExperimentRepeater:
         it cannot account for problems that have not yet been run once.
 
         Calling ``done()`` increments the sweep counter iff it returns
-        `False`, the default for ``max_sweeps`` is ``1e4``. The attribute
+        `False`, the default for ``max_sweeps`` is ``20``. The attribute
         can be directly reassigned at any time.
 
         See also: `remaining_problems`
@@ -861,11 +881,11 @@ class ExperimentRepeater:
             return True
         if message:  # prints nothing when no data are found
             print(self.message_sweep(), end='')  # indicates "sequence of problems" case
-        self._sweeps += 1  # the sweep number to come
-        done = self._sweeps >= self.max_sweeps or (
+        self._sweeps += 1  # the sweep number to come, needed in remaining_problems()
+        done = self._sweeps > self.max_sweeps or (
                 self._sweeps > 1 and len(self._data) == 0) or (
                 self.n_problem_instances() > 0 and not self.remaining_problems())
-        self._sweeps -= done  # don't increment when done
+        self._sweeps -= done  # revert increment when done is True
         return done
     def remaining_problems(self, suite=None):
         """return `list` of (probably) remaining problem instances to run.