ade package documentation
Asynchronous Differential Evolution.
You really just need to be concerned with two things: Constructing and
setting up a Population object,
and constructing and calling a DifferentialEvolution
object with it.
| Module | abort | Takes care of aborting Population and DifferentialEvolution
on console keystroke. |
| Module | args | A very handy convenience class for making argparse even easier. See the
examples scripts of ade
to see how it is used. |
| Module | constraints | The Constraints base
class makes it easier for you to enforce parameter constraints. If you have
any highly correlated parameters, an instance of RelationsChecker
may be helpful, too. |
| Module | de | DifferentialEvolution
and support staff. |
| Package | examples | Examples for ade. |
| Module | history | A History class for
maintaining a history of Individual
objects. |
| Module | image | Visualizing the progress of de. |
| Module | individual | An Individual
class for parameter combinations to be evaluated. |
| Module | population | A Population
class and helpers. |
| Module | report | A Reporter class for
reporting on the SSE of individuals in an evolving population. |
| Package | scripts | Scripts for ade. |
| Module | specs | For defining specifications of an individual, including but not limited to parameter ranges. |
| Package | test | Unit tests for ade. |
| Module | util | Utility stuff used by most modules of ade. Imports the author's public-domain
convenience class Args from a
separate module args. |
From the __init__.py module:
| Function | extract_examples | Call via the ade-examples entry point to extract example files to a subdirectory ade-examples of your home directory, creating the subdirectory if necessary. |
def
extract_examples():
Call via the ade-examples entry point to extract example files to a subdirectory ade-examples of your home directory, creating the subdirectory if necessary.
It will not overwrite existing files, so feel free to modify the examples. Delete a modified example file (or the whole subdirectory) and run this again to restore the default file.