Changeset 715

Timestamp:

04/03/14 15:37:12 (2 years ago)

Author:

mmckerns

Message:

renamed 'nested' solvers as 'ensemble' solvers

Location:

mystic

Files:

• README.md (modified) (1 diff)
• mystic/abstract_ensemble_solver.py (moved) (moved from mystic/mystic/abstract_nested_solver.py) (5 diffs)
• mystic/ensemble.py (moved) (moved from mystic/mystic/nested.py) (7 diffs)
• mystic/solvers.py (modified) (2 diffs)
• setup.py (modified) (2 diffs)

mystic/README.md

@@ -55 +55 @@
     http://mmckerns.github.io/project/mystic
 
-Mystic is distributed under a modified BSD license.
+Mystic is distributed under a 3-clause BSD license.
 
 Development Release

mystic/mystic/abstract_ensemble_solver.py

@@ -6 +6 @@
 #  - http://mmckerns.github.io/project/mystic/browser/mystic/LICENSE
 #
-# Abstract Nested Solver Class
+# Abstract Ensemble Solver Class
 """
 This module contains the base class for launching several mystic solvers
 instances -- utilizing a parallel "map" function to enable parallel
-computing.  This module describes the nested solver interface.  As with
+computing.  This module describes the ensemble solver interface.  As with
 the AbstractSolver, the "Solve" method must be overwritten with the derived
 solver's optimization algorithm. Similar to AbstractMapSolver, a call to
@@ -26 +26 @@
 =====
 
-A typical call to a 'nested' solver will roughly follow this example:
+A typical call to a 'ensemble' solver will roughly follow this example:
 
     >>> # the function to be minimized and the initial values
@@ -75 +75 @@
 
 """
-__all__ = ['AbstractNestedSolver']
+__all__ = ['AbstractEnsembleSolver']
 
 
@@ -82 +82 @@
 
 
-class AbstractNestedSolver(AbstractMapSolver):
+class AbstractEnsembleSolver(AbstractMapSolver):
     """
-AbstractNestedSolver base class for mystic optimizers that are nested within
+AbstractEnsembleSolver base class for mystic optimizers that are called within
 a parallel map.  This allows pseudo-global coverage of parameter space using
 non-global optimizers.
@@ -111 +111 @@
     signal_handler   - catches the interrupt signal.         [***disabled***]
         """
-        super(AbstractNestedSolver, self).__init__(dim, **kwds)
+        super(AbstractEnsembleSolver, self).__init__(dim, **kwds)
        #self.signal_handler   = None
        #self._handle_sigint   = False

mystic/mystic/ensemble.py

@@ -9 +9 @@
 =======
 
-This module contains a collection of optimization that use map-reduce
+This module contains a collection of optimization routines that use "map"
 to distribute several optimizer instances over parameter space. Each
 solver accepts a imported solver object as the "nested" solver, which
 becomes the target of the map function.
 
-The set of solvers built on mystic's AbstractNestdSolver are::
+The set of solvers built on mystic's AbstractEnsembleSolver are::
    LatticeSolver -- start from center of N grid points
    BuckshotSolver -- start from N random points in parameter space
@@ -33 +33 @@
 from mystic.tools import wrap_function
 
-from mystic.abstract_nested_solver import AbstractNestedSolver
-
-
-class LatticeSolver(AbstractNestedSolver):
+from mystic.abstract_ensemble_solver import AbstractEnsembleSolver
+
+
+class LatticeSolver(AbstractEnsembleSolver):
     """
 parallel mapped optimization starting from the center of N grid points
@@ -46 +46 @@
     nbins -- tuple of number of bins in each dimension
 
-All important class members are inherited from AbstractNestedSolver.
+All important class members are inherited from AbstractEnsembleSolver.
         """
         super(LatticeSolver, self).__init__(dim, nbins=nbins)
@@ -111 +111 @@
 
         # get the nested solver instance
-        solver = self._AbstractNestedSolver__get_solver_instance()
+        solver = self._AbstractEnsembleSolver__get_solver_instance()
         #-------------------------------------------------------------
 
@@ -204 +204 @@
         return 
 
-class BuckshotSolver(AbstractNestedSolver):
+class BuckshotSolver(AbstractEnsembleSolver):
     """
 parallel mapped optimization starting from the N random points
@@ -214 +214 @@
     npts  -- number of parallel solver instances
 
-All important class members are inherited from AbstractNestedSolver.
+All important class members are inherited from AbstractEnsembleSolver.
         """
         super(BuckshotSolver, self).__init__(dim, npts=npts)
@@ -275 +275 @@
 
         # get the nested solver instance
-        solver = self._AbstractNestedSolver__get_solver_instance()
+        solver = self._AbstractEnsembleSolver__get_solver_instance()
         #-------------------------------------------------------------
 

mystic/mystic/solvers.py

@@ -47 +47 @@
 
 For more information, please see the solver documentation found here::
-    - mystic.mystic.differential_evolution [differential evolution solvers]
-    - mystic.mystic.scipy_optimize         [scipy local-search solvers]
-    - mystic.mystic.nested                 [pseudo-global solvers]
+    - mystic.mystic.differential_evolution   [differential evolution solvers]
+    - mystic.mystic.scipy_optimize           [scipy local-search solvers]
+    - mystic.mystic.ensemble                 [pseudo-global solvers]
 
 or the API documentation found here::
-    - mystic.mystic.abstract_solver        [the solver API definition]
-    - mystic.mystic.abstract_map_solver    [the parallel solver API]
-    - mystic.mystic.abstract_nested_solver [the nested solver API]
+    - mystic.mystic.abstract_solver          [the solver API definition]
+    - mystic.mystic.abstract_map_solver      [the parallel solver API]
+    - mystic.mystic.abstract_ensemble_solver [the ensemble solver API]
 
 
@@ -64 +64 @@
 
 # pseudo-global optimizers
-from nested import BuckshotSolver
-from nested import LatticeSolver
+from ensemble import BuckshotSolver
+from ensemble import LatticeSolver
 
 # local-search optimizers

mystic/setup.py

@@ -203 +203 @@
 by the `pathos` package, and thus with little new code solvers are
 extended to high-performance computing. For more information, see
-`mystic.mystic.abstract_map_solver`, `mystic.mystic.abstract_nested_solver`,
+`mystic.mystic.abstract_map_solver`, `mystic.mystic.abstract_ensemble_solver`,
 and the pathos documentation at http://dev.danse.us/trac/pathos.
 
 Important classes and functions are found here::
 
-    - mystic.mystic.solvers                [solver optimization algorithms]
-    - mystic.mystic.termination            [solver termination conditions]
-    - mystic.mystic.strategy               [solver population mutation strategies]
-    - mystic.mystic.monitors               [optimization monitors]
-    - mystic.mystic.tools                  [function wrappers, etc]
-    - mystic.mystic.forward_model          [cost function generator]
-    - mystic.models                        [a collection of standard models]
-    - mystic.math                          [some mathematical functions and tools]
+    - mystic.mystic.solvers                  [solver optimization algorithms]
+    - mystic.mystic.termination              [solver termination conditions]
+    - mystic.mystic.strategy                 [solver population mutation strategies]
+    - mystic.mystic.monitors                 [optimization monitors]
+    - mystic.mystic.tools                    [function wrappers, etc]
+    - mystic.mystic.forward_model            [cost function generator]
+    - mystic.models                          [a collection of standard models]
+    - mystic.math                            [some mathematical functions and tools]
 
 Solver and model API definitions are found here::
 
-    - mystic.mystic.abstract_solver        [the solver API definition]
-    - mystic.mystic.abstract_map_solver    [the parallel solver API]
-    - mystic.mystic.abstract_nested_solver [the nested solver API]
-    - mystic.models.abstract_model         [the model API definition]
+    - mystic.mystic.abstract_solver          [the solver API definition]
+    - mystic.mystic.abstract_map_solver      [the parallel solver API]
+    - mystic.mystic.abstract_ensemble_solver [the ensemble solver API]
+    - mystic.models.abstract_model           [the model API definition]
 
 
@@ -228 +228 @@
 =======
 
-Mystic is distributed under a modified BSD license.
+Mystic is distributed under a 3-clause BSD license.
 
     >>> import mystic