Skip to main content
Ctrl+K

ODAT-SE API documentation

  • odatse
  • odatse

Section Navigation

  • odatse package
    • odatse.algorithm package
      • odatse.algorithm._algorithm module
      • odatse.algorithm._iterator module
      • odatse.algorithm.bayes module
      • odatse.algorithm.exchange module
      • odatse.algorithm.gather module
      • odatse.algorithm.global_search module
      • odatse.algorithm.mapper_mpi module
      • odatse.algorithm.mapper_mpi_base module
      • odatse.algorithm.min_search module
      • odatse.algorithm.montecarlo module
      • odatse.algorithm.pamc module
      • odatse.algorithm.random_search module
      • odatse.algorithm.state module
      • odatse.algorithm.ttopt module
    • odatse.domain package
      • odatse.domain._domain module
      • odatse.domain.meshgrid module
      • odatse.domain.region module
    • odatse.scripts package
      • odatse.scripts.extract_combined module
      • odatse.scripts.plt_1D_histogram module
      • odatse.scripts.plt_2D_histogram module
      • odatse.scripts.plt_model_evidence module
      • odatse.scripts.separateT module
      • odatse.scripts.summarize_each_T module
    • odatse.solver package
      • odatse.solver._solver module
      • odatse.solver.analytical module
      • odatse.solver.function module
    • odatse.util package
      • odatse.util.data_writer module
      • odatse.util.graph module
      • odatse.util.limitation module
      • odatse.util.logger module
      • odatse.util.mapping module
      • odatse.util.neighborlist module
      • odatse.util.read_matrix module
      • odatse.util.read_ts module
      • odatse.util.resampling module
      • odatse.util.separateT module
      • odatse.util.toml module
      • odatse.util.version module
    • odatse.__main__ module
    • odatse._info module
    • odatse._initialize module
    • odatse._main module
    • odatse._runner module
    • odatse._version module
    • odatse.exception module
    • odatse.mpi module
  • odatse
  • odatse package
  • odatse.algorithm package
  • odatse.algorithm.min_search module

odatse.algorithm.min_search module#

class odatse.algorithm.min_search.Algorithm(info: Info, runner: Runner = None, domain=None, run_mode: str = 'initial')[source]#

Bases: AlgorithmBase

Algorithm class for performing minimization using scipy.optimize.minimize.

The optimization method is selected by the method parameter in the [algorithm.minimize] section (default: “Nelder-Mead”). All other entries of the section except ODAT-SE-specific keys are passed through to scipy.optimize.minimize as its options argument.

Setting basinhopping (a boolean, or a [algorithm.minimize.basinhopping] table whose entries are passed to scipy.optimize.basinhopping) switches to global optimization by basin hopping, with the configured method serving as the local minimizer.

Initialize the Algorithm class.

Parameters:
  • info (Info) – Information object containing algorithm settings.

  • runner (Runner) – Runner object for submitting jobs.

  • domain – Domain object defining the search space.

  • run_mode (str) – Mode of running the algorithm.

__init__(info: Info, runner: Runner = None, domain=None, run_mode: str = 'initial') → None[source]#

Initialize the Algorithm class.

Parameters:
  • info (Info) – Information object containing algorithm settings.

  • runner (Runner) – Runner object for submitting jobs.

  • domain – Domain object defining the search space.

  • run_mode (str) – Mode of running the algorithm.

_initialize() → None[source]#

Set up initial state for a fresh run.

Nelder-Mead does not use checkpointing, so this is a no-op. The simplex initialisation is done in _prepare().

_output_results()[source]#

Output the results of the minimization to files.

_post()[source]#

Post-process the results after minimization.

_prepare()[source]#

Prepare the initial simplex for the Nelder-Mead algorithm.

The simplex is only passed to scipy when method is Nelder-Mead; for other methods it is built but unused.

_run() → None[source]#

Run the minimization algorithm.

class odatse.algorithm.min_search._ClippedRandomDisplacement(rng, stepsize, min_list, max_list)[source]#

Bases: object

Random displacement for basinhopping, clipped to the search region.

The default take_step of scipy’s basinhopping may propose points outside [min_list, max_list], which would only waste solver evaluations on the inf-penalty. Clipping keeps every hop inside the region. The stepsize attribute is exposed so that basinhopping’s adaptive stepsize adjustment keeps working.

previous

odatse.algorithm.mapper_mpi_base module

next

odatse.algorithm.montecarlo module

On this page
  • Algorithm
    • Algorithm.__init__()
    • Algorithm._initialize()
    • Algorithm._output_results()
    • Algorithm._post()
    • Algorithm._prepare()
    • Algorithm._run()
  • _ClippedRandomDisplacement
Show Source

© Copyright 2020-, ISSP, UTokyo.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.21.0.