diff --git a/docs/conf.py b/docs/conf.py index 9cf12549a..edb3f2e16 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -83,7 +83,7 @@ "sphinx.ext.intersphinx", # Links to other documentations like numpy, python,... "sphinx.ext.viewcode", # Links to code ] -myst_enable_extensions = ["dollarmath"] +myst_enable_extensions = ["dollarmath"] # Enables Latex-like math in markdown files # Tell sphinx where to find the templates diff --git a/docs/userguide/constraints.md b/docs/userguide/constraints.md index 4866cde07..8102bc3a2 100644 --- a/docs/userguide/constraints.md +++ b/docs/userguide/constraints.md @@ -16,7 +16,7 @@ discrete / continuous parameters. ```{note} Currently, BayBE does not support hybrid constraints, that is, constraints which operate on a mixed set of discrete and continuous parameters. If such a constraint is -necessary in almost al cases it is possible to rephrase the parametrization so that +necessary in almost all cases it is possible to rephrase the parametrization so that the parameter set is exclusively discrete or continuous. ``` @@ -64,7 +64,7 @@ $c_i$ is the coefficient for that parameter. $\text{rhs}$ is a user-chosen numbe ```{info} You can specify a constraint involving ```<=``` instead of ```>=``` by multiplying -both sides by -1, i.e. multiply both the coefficients and rhs by -1. +both sides, i.e. the coefficients and rhs, by -1. ``` Let us amend the example from diff --git a/docs/userguide/parameters.md b/docs/userguide/parameters.md index 56d6f90b1..cc8b1368d 100644 --- a/docs/userguide/parameters.md +++ b/docs/userguide/parameters.md @@ -10,9 +10,8 @@ BayBE identifies each parameter by a ```name```. All parameter names in one campaign must be unique. ``` -BayBE distinguishes several parameter types. Because under the hood they need to be -treated very differently, we classify parameters in two different families: discrete -and continuous parameters. +Because under the hood they need to be treated very differently, BayBE distinguishes +two parameter types: Discrete and continuous parameters. ## Continuous Parameters @@ -33,7 +32,7 @@ NumericalContinuousParameter( ``` ## Discrete Parameters -A discrete parameter has a finite, countable set of possible values. +A discrete parameter has a finite set of possible values. These values can be numeric or label-like and are transformed internally before being ingested by the surrogate model. @@ -151,7 +150,7 @@ additional ```chem``` dependency. ``` ### ```CustomDiscreteParameter``` -Take the ```encoding``` concept introduced above is generalized by the +The ```encoding``` concept introduced above is generalized by the ```CustomParameter```. Here, the user is expected to provide their own descriptors for the encoding.