Add setting for default heartbeat interval (#914)

IDSIA · May 2, 2023 · d668b53 · d668b53
1 parent 0a7320a
commit d668b53
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/docs/settings.rst b/docs/settings.rst
@@ -19,7 +19,7 @@ Here is a brief list of all currently available options.
 
 * ``CAPTURE_MODE`` *(default: 'fd' (linux/osx) or 'sys' (windows))*
   configure how stdout/stderr are captured. ['no', 'sys', 'fd']
-
+* ``DEFAULT_BEAT_INTERVAL`` *(default: 10.0)* Configures the default beat interval
 * ``CONFIG``
 
   * ``ENFORCE_KEYS_MONGO_COMPATIBLE`` *(default: True)*

diff --git a/sacred/run.py b/sacred/run.py
@@ -6,7 +6,7 @@
 import sys
 import traceback as tb
 
-from sacred import metrics_logger
+from sacred import metrics_logger, SETTINGS
 from sacred.metrics_logger import linearize_metrics
 from sacred.randomness import set_global_seed
 from sacred.utils import SacredInterrupt, join_paths, IntervalTimer
@@ -91,7 +91,7 @@ def __init__(
         self.meta_info = {}
         """A custom comment for this run"""
 
-        self.beat_interval = 10.0  # sec
+        self.beat_interval = SETTINGS.DEFAULT_BEAT_INTERVAL  # sec
         """The time between two heartbeat events measured in seconds"""
 
         self.unobserved = False

diff --git a/sacred/settings.py b/sacred/settings.py
@@ -112,6 +112,8 @@ def __deepcopy__(self, memodict=None):
         "DISCOVER_DEPENDENCIES": "imported",
         # configure how source-files are discovered. [none, imported, sys, dir]
         "DISCOVER_SOURCES": "imported",
+        # Configure the default beat interval, in seconds
+        "DEFAULT_BEAT_INTERVAL": 10.0,
     },
 )
 SETTINGS.freeze_keys()