From 2f79fc34a42d37afcf557588b9756fee2c059bff Mon Sep 17 00:00:00 2001 From: Sawsane Date: Tue, 13 Oct 2020 15:16:09 +0200 Subject: [PATCH] added documentation for fast_forward --- docs/source/configuration.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index 6fef3ec1d..13e4bfd4a 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -778,3 +778,25 @@ local_test (\ *default = 1*\ ) +fast_forward +^^^^^^^^^^ + + +.. + + This parameter allows the checkpoint interval to be speeded up by the value given to this parameter. In other words, the interval is divided by the fast_forward value. For example, if ckpt_l1 is set to 15, a fast_forward configuration of 5 will result in L1 checkpoints every 3 minutes. A fast_forward rate of 1 keeps the same checkpoint interval frequency. + + +.. list-table:: + :header-rows: 1 + + * - Value + - Meaning + * - int + - Fast forward rate. Must be between 1 and 10. + + +(\ *default = 1*\ ) + + +