From 361826ab591dd498803173c81d0f07173e67e1e9 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Mon, 27 Jun 2022 10:03:53 +0200 Subject: [PATCH 1/4] Clarify implications of 'parameterScale' --- doc/documentation_data_format.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/doc/documentation_data_format.rst b/doc/documentation_data_format.rst index da20fda8..5df59589 100644 --- a/doc/documentation_data_format.rst +++ b/doc/documentation_data_format.rst @@ -494,23 +494,33 @@ Detailed field description Scale of the parameter to be used during parameter estimation. + ``lin`` + Use the objective value, ``lowerBound``, ``upperBound``, and + ``nominalValue`` without transformation. + ``log`` + Take the natural logarithm of the objective value, ``lowerBound``, + ``upperBound``, and ``nominalValue`` during parameter estimation. + ``log10`` + Take the logarithm to base 10 of the objective value, ``lowerBound``, + ``upperBound``, and ``nominalValue`` during parameter estimation. + - ``lowerBound`` [NUMERIC] Lower bound of the parameter used for estimation. Optional, if ``estimate==0``. - Must be provided in linear space, independent of ``parameterScale``. + The provided value will be transformed according to ``parameterScale``. - ``upperBound`` [NUMERIC] Upper bound of the parameter used for estimation. Optional, if ``estimate==0``. - Must be provided in linear space, independent of ``parameterScale``. + The provided value will be transformed according to ``parameterScale``. - ``nominalValue`` [NUMERIC] Some parameter value to be used if the parameter is not subject to estimation (see ``estimate`` below). - Must be provided in linear space, independent of ``parameterScale``. + The provided value will be transformed according to ``parameterScale``. Optional, unless ``estimate==0``. - ``estimate`` [BOOL 0|1] From d39f9f6e7ef42b01e549745e8299f99e768f5b98 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Mon, 27 Jun 2022 10:59:36 +0200 Subject: [PATCH 2/4] Update doc/documentation_data_format.rst Co-authored-by: Dilan Pathirana <59329744+dilpath@users.noreply.github.com> --- doc/documentation_data_format.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/documentation_data_format.rst b/doc/documentation_data_format.rst index 5df59589..01d6f6fb 100644 --- a/doc/documentation_data_format.rst +++ b/doc/documentation_data_format.rst @@ -495,13 +495,13 @@ Detailed field description Scale of the parameter to be used during parameter estimation. ``lin`` - Use the objective value, ``lowerBound``, ``upperBound``, and + Use the parameter value, ``lowerBound``, ``upperBound``, and ``nominalValue`` without transformation. ``log`` - Take the natural logarithm of the objective value, ``lowerBound``, + Take the natural logarithm of the parameter value, ``lowerBound``, ``upperBound``, and ``nominalValue`` during parameter estimation. ``log10`` - Take the logarithm to base 10 of the objective value, ``lowerBound``, + Take the logarithm to base 10 of the parameter value, ``lowerBound``, ``upperBound``, and ``nominalValue`` during parameter estimation. - ``lowerBound`` [NUMERIC] From 746558937dadc6588ed57572f3a74c2fbede7653 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Fri, 10 Mar 2023 07:21:46 +0100 Subject: [PATCH 3/4] Update doc/documentation_data_format.rst Co-authored-by: Dilan Pathirana <59329744+dilpath@users.noreply.github.com> --- doc/documentation_data_format.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/documentation_data_format.rst b/doc/documentation_data_format.rst index 01d6f6fb..32d425a2 100644 --- a/doc/documentation_data_format.rst +++ b/doc/documentation_data_format.rst @@ -508,7 +508,7 @@ Detailed field description Lower bound of the parameter used for estimation. Optional, if ``estimate==0``. - The provided value will be transformed according to ``parameterScale``. + The provided value should be untransformed, as it will be transformed according to ``parameterScale`` during parameter estimation. - ``upperBound`` [NUMERIC] From 8fee996f094e021c2bb453633bf53debeb750c69 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Fri, 10 Mar 2023 07:23:47 +0100 Subject: [PATCH 4/4] .. --- doc/documentation_data_format.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/documentation_data_format.rst b/doc/documentation_data_format.rst index 32d425a2..2ab6f9ad 100644 --- a/doc/documentation_data_format.rst +++ b/doc/documentation_data_format.rst @@ -508,19 +508,22 @@ Detailed field description Lower bound of the parameter used for estimation. Optional, if ``estimate==0``. - The provided value should be untransformed, as it will be transformed according to ``parameterScale`` during parameter estimation. + The provided value should be untransformed, as it will be transformed + according to ``parameterScale`` during parameter estimation. - ``upperBound`` [NUMERIC] Upper bound of the parameter used for estimation. Optional, if ``estimate==0``. - The provided value will be transformed according to ``parameterScale``. + The provided value should be untransformed, as it will be transformed + according to ``parameterScale`` during parameter estimation. - ``nominalValue`` [NUMERIC] Some parameter value to be used if the parameter is not subject to estimation (see ``estimate`` below). - The provided value will be transformed according to ``parameterScale``. + The provided value should be untransformed, as it will be transformed + according to ``parameterScale`` during parameter estimation. Optional, unless ``estimate==0``. - ``estimate`` [BOOL 0|1]