Skip to content

Commit ff435d0

Browse files
dweindldilpath
andcommitted
Clarify implications of 'parameterScale' (#547)
Co-authored-by: Dilan Pathirana <[email protected]>
1 parent ff31205 commit ff435d0

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

doc/documentation_data_format.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -495,23 +495,36 @@ Detailed field description
495495

496496
Scale of the parameter to be used during parameter estimation.
497497

498+
``lin``
499+
Use the parameter value, ``lowerBound``, ``upperBound``, and
500+
``nominalValue`` without transformation.
501+
``log``
502+
Take the natural logarithm of the parameter value, ``lowerBound``,
503+
``upperBound``, and ``nominalValue`` during parameter estimation.
504+
``log10``
505+
Take the logarithm to base 10 of the parameter value, ``lowerBound``,
506+
``upperBound``, and ``nominalValue`` during parameter estimation.
507+
498508
- ``lowerBound`` [NUMERIC]
499509

500510
Lower bound of the parameter used for estimation.
501511
Optional, if ``estimate==0``.
502-
Must be provided in linear space, independent of ``parameterScale``.
512+
The provided value should be untransformed, as it will be transformed
513+
according to ``parameterScale`` during parameter estimation.
503514

504515
- ``upperBound`` [NUMERIC]
505516

506517
Upper bound of the parameter used for estimation.
507518
Optional, if ``estimate==0``.
508-
Must be provided in linear space, independent of ``parameterScale``.
519+
The provided value should be untransformed, as it will be transformed
520+
according to ``parameterScale`` during parameter estimation.
509521

510522
- ``nominalValue`` [NUMERIC]
511523

512524
Some parameter value to be used if
513525
the parameter is not subject to estimation (see ``estimate`` below).
514-
Must be provided in linear space, independent of ``parameterScale``.
526+
The provided value should be untransformed, as it will be transformed
527+
according to ``parameterScale`` during parameter estimation.
515528
Optional, unless ``estimate==0``.
516529

517530
- ``estimate`` [BOOL 0|1]

0 commit comments

Comments
 (0)