Clarify meaning of initializationPrior*

Consensus seems to be that the use of initialization priors is optional. Closes #587.
PEtab-dev · Dec 4, 2024 · de5f73c · de5f73c
1 parent 5a7a198
commit de5f73c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/v2/documentation_data_format.rst b/doc/v2/documentation_data_format.rst
@@ -579,6 +579,11 @@ Detailed field description
   points are clipped to lie inside the parameter boundaries specified by
   ``lowerBound`` and ``upperBound``. Defaults to ``parameterScaleUniform``.
 
+  This is a hint for the optimization algorithm to start the optimization
+  process or for re-sampling random points. The initialization prior does not
+  change the objective function itself. Optimizers may choose to ignore this
+  information.
+
   Possible prior types are:
 
     - *uniform*: flat prior on linear parameters