Skip to content

Commit

Permalink
Fix grammar / typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Scienfitz committed Dec 4, 2023
1 parent a73a32d commit 12937f2
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/userguide/constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

Expand Down Expand Up @@ -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
Expand Down
9 changes: 4 additions & 5 deletions docs/userguide/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit 12937f2

Please sign in to comment.