From 2fcd22059bf92e1f443aba8cf0e1897745d1e319 Mon Sep 17 00:00:00 2001
From: Johannes Pfeifer <jpfeifer@gmx.de>
Date: Wed, 26 Feb 2020 11:34:08 +0100
Subject: [PATCH] Add documentation for the mh_tune_jscale_initial_guess option
Related to https://git.dynare.org/Dynare/preprocessor/-/merge_requests/16
---
doc/manual/source/the-model-file.rst | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/doc/manual/source/the-model-file.rst b/doc/manual/source/the-model-file.rst
index f2bb323b67..a04b8fbcbe 100644
--- a/doc/manual/source/the-model-file.rst
+++ b/doc/manual/source/the-model-file.rst
@@ -4642,7 +4642,8 @@ block decomposition of the model (see :opt:`block`).
Note also that for the Random Walk Metropolis Hastings
algorithm, it is possible to use option :opt:`mh_tune_jscale
<mh_tune_jscale [= DOUBLE]>`, to automatically tune the value
- of ``mh_jscale``.
+ of ``mh_jscale``. In this case, the ``mh_jscale``-value must
+ not be set.
.. option:: mh_init_scale = DOUBLE
@@ -4681,6 +4682,11 @@ block decomposition of the model (see :opt:`block`).
``mh_nblocks>1``). This option is only available for the
Random Walk Metropolis Hastings algorithm.
+ .. option:: mh_tune_jscale_initial_guess = DOUBLE
+
+ Specifies the initial value for the :opt:`mh_tune_jscale
+ <mh_tune_jscale [= DOUBLE]>`-option. Default: ``0.2``.
+
.. option:: mh_recover
Attempts to recover a Metropolis-Hastings simulation that
--
GitLab