Skip to content

Commit

Permalink
Changes following Michaël's review
Browse files Browse the repository at this point in the history
  • Loading branch information
josephmure committed Aug 23, 2023
1 parent cd67609 commit ccd1fec
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions python/src/RandomWalkMetropolisHastings_doc.i.in
Original file line number Diff line number Diff line change
Expand Up @@ -168,13 +168,15 @@ expansionFactor : float, :math:`e > 1`
During burn-in, at the end of every adaptation period,
if the acceptance rate does not belong to this range,
the adaptation factor is multiplied
either by the expansion factor (if the acceptance rate is too high)
or by the shrink factor (if the acceptance rate is too low).
either by the expansion factor
(if the acceptance rate is larger than the *upperBound*)
or by the shrink factor
(if the acceptance rate is smaller than the *lowerBound*).

Returns
-------
range : :class:`~openturns.Interval` of dimension 1
Range :math:`[m,M]` of the expected acceptance rate."
Range [*lowerBound*, *upperBound*] of the expected acceptance rate."

// ---------------------------------------------------------------------

Expand All @@ -183,13 +185,15 @@ range : :class:`~openturns.Interval` of dimension 1
During burn-in, at the end of every adaptation period,
if the acceptance rate does not belong to this range,
the adaptation factor is multiplied
either by the expansion factor (if the acceptance rate is too high)
or by the shrink factor (if the acceptance rate is too low).
either by the expansion factor
(if the acceptance rate is larger than the *upperBound*)
or by the shrink factor
(if the acceptance rate is smaller than the *lowerBound*).

Parameters
----------
range : :class:`~openturns.Interval` of dimension 1
Range :math:`[m,M]` of the expected acceptance rate."
Range [*lowerBound*, *upperBound*] of the expected acceptance rate."

// ---------------------------------------------------------------------

Expand Down

0 comments on commit ccd1fec

Please sign in to comment.