Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick Kunzmann committed Jun 1, 2022
1 parent 8d94f21 commit 009ddf1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
9 changes: 6 additions & 3 deletions doc/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,15 @@ In order to increase the quality of the scheme tha amount of optimization steps
(``--nsteps``) or the number of runs (``--nruns``) can be increased.
However, increasing these values also extends the runtime of the optimization.
Note that ``--nruns`` can take advantage of multiple cores.
The number of used cores is set with ``--nthreads``

The simulated annealing can be adjusted even more fine grained by setting
the initial reverse temperature (``--beta``) and the rate of its exponential
growth (``--rate``). The step size decreases in the course of the simulated
the inverse temperature at the first (``--beta-start``) and last
(``--beta-end``) step of the optimization.
For the steps in between the inverse temperature is interpolated exponentially.
The step size decreases in the course of the simulated
annealing also in an exponential manner, which can be parameterized via
``--step-size-start`` and ``--step-size-end``.
``--stepsize-start`` and ``--stepsize-end``.
The seed for the random number generator used by the algorithm is set with
the ``--seed`` option.
However, these parameters address the more advanced users.
Expand Down
7 changes: 1 addition & 6 deletions doc/theory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,12 +173,7 @@ an exponential schedule for the step size
The step size is used for perturbing the current solution in each step of the
SA algorithm to find a new candidate solution.
So the idea for using the schedule here is to start with relatively large
step size :math:`\delta_{start}` and to chose the rate according to an
target step size :math:`\delta_{end}`.
An according rate is easily derived by claiming
:math:`\delta(N_{max})=\delta_{end}` which leads to

.. math:: \gamma = \frac{1}{N_{max}}\log \left( \frac{\delta_{end}}{\delta_{start}} \right).
step size and reduce it over the course of the simulation.


Monte-Carlo algorithm
Expand Down

0 comments on commit 009ddf1

Please sign in to comment.