docs: update FAQ for issue of large hyper parameter space

config: reduce default hypers bounds
hvasbath · May 24, 2023 · 1420905 · 1420905
1 parent d2ca59d
commit 1420905
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 8 deletions.
diff --git a/beat/config.py b/beat/config.py
@@ -211,7 +211,7 @@
     bl_azimuth=(0, 180),
     bl_amplitude=(0.0, 0.1),
     locking_depth=(1.0, 10.0),
-    hypers=(-5.0, 8.0),
+    hypers=(-2.0, 6.0),
     ramp=(-0.005, 0.005),
     offset=(-0.05, 0.05),
     lat=(30.0, 30.5),

diff --git a/beat/sampler/smc.py b/beat/sampler/smc.py
@@ -186,7 +186,10 @@ def calc_covariance(self):
 
         cov = utility.ensure_cov_psd(cov)
         if np.isnan(cov).any() or np.isinf(cov).any():
-            raise ValueError("Sample covariances contains Inf or NaN!")
+            raise ValueError(
+                "Sample covariances contains Inf or NaN! Please try reducing the"
+                " upper and lower bounds of hyper parameters!"
+            )
         return cov
 
     def select_end_points(self, mtrace):

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -3,14 +3,12 @@ Frequently asked questions
 --------------------------
 | Below you find a list for known errors, that may occur and how to work around:
 |
-| **1. HDF5surrogate escape**
+| **1. Sample covariance contains Nan or Inf**
 
-NameError: global name 'exc' is not defined
+The variations in the likelihood space are too large. When normalising the space this may result in inf or Nan.
+Please reduce the potential search interval for hyper parameters "h_*", i.e. reduce and/or increase the upper and/or lower bounds in the
+project config_*.yaml, respectively.
 
-| add:
-| export LC_ALL=en_AU.utf8
-| to your .bashrc
-|
 | **2. Theano MKL support**
 
 RuntimeError: To use MKL 2018 with Theano you MUST set "MKL_THREADING_LAYER=GNU" in your environment.
@@ -66,3 +64,11 @@ X forwarding needs to be activated in the ssh config! For linux:
 3. in the shell run::
 
     systemctl restart sshd   # could require sudo rights
+
+| **9. HDF5surrogate escape**
+
+NameError: global name 'exc' is not defined
+
+| add:
+| export LC_ALL=en_AU.utf8
+| to your .bashrc
diff --git a/docs/short_installation.rst b/docs/short_installation.rst
@@ -45,6 +45,10 @@ In the activated environment we install the latest release of *beat* through the
 Install beat from source (github)
 ---------------------------------
 
+Please make sure to activate your virtual environment! e.g.::
+
+    source ~/virtualenvs/beat_env/bin/activate
+
 Get the development version through the github repository::
 
     cd ~/src  # or wherever you keep the packages