Skip to content

Commit 4969232

Browse files
committed
adding documentation
1 parent 663a953 commit 4969232

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

doc/src/extensions.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,17 @@ This is a good extension to look at as a first example. It takes a
6969
dictionary with iteration numbers and mipgaps as input and changes the
7070
mipgap at the corresponding iterations. The dictionary is provided in
7171
the options dictionary in ``["gapperoptions"]["mipgapdict"]``. There
72-
is an example of its use in ``examples.sizes.sizes_demo.py``
72+
is an example of its use in ``examples.sizes.sizes_demo.py``.
73+
74+
Instead of an options dictionary, when run with cylinders the options
75+
``["gapperoptions"]["starting_mipgap"]`` and ``["gapperoptions"]["mipgap_ratio"]``
76+
can be set. The ``starting_mipgap`` will be the initial value used,
77+
and as the cylinders close the relative optimality gap the extension will set the subproblem
78+
mipgaps as the ``min(starting_mipgap, mipgap_ratio * problem_ratio)``, where
79+
the ``problem_ratio`` is the relative optimality gap on the overall problem
80+
as computed by the cylinders.
81+
82+
This extension can also be used with the Lagrangian and subgradient spokes.
7383

7484
fixer.py
7585
^^^^^^^^

0 commit comments

Comments
 (0)