Skip to content

Commit 0e8682e

Browse files
committed
Rewrite userguide
1 parent 0793216 commit 0e8682e

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

docs/userguide/constraints.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,20 @@ the constraints are currently silently ignored.
3535

3636
(CLC)=
3737
### ContinuousLinearConstraint
38+
3839
The [`ContinuousLinearConstraint`](baybe.constraints.continuous.ContinuousLinearConstraint)
40+
is used to model linear relationship between between continuous parameters.
41+
BayBE support two different kinds of continuous linear constraints:
42+
1. **Intrapoint constraints:** These constraints model the relationship between the parameters
43+
within (*intra-*) individual experiments (*-points*) and are what people typically think of when
44+
simply speaking about "constraints". For that reason, a `ContinuousLinearConstraint` is
45+
interpreted as an intrapoint constraint if not explicitly declared otherwise.
46+
2. **Interpoint constraints:** These constraints model the relationship of different experiments
47+
across the whole batch (*inter-*) of exeriments (*-points*).
48+
49+
#### Intrapoint constraints
50+
When not explicitly declaring it an interpoint constraint, the
51+
[`ContinuousLinearConstraint`](baybe.constraints.continuous.ContinuousLinearConstraint)
3952
asserts that the following kind of equations are true (up to numerical rounding errors):
4053

4154
$$
@@ -82,20 +95,23 @@ ContinuousLinearConstraint(
8295
A more detailed example can be found
8396
[here](../../examples/Constraints_Continuous/linear_constraints).
8497

85-
### Continuous Interpoint Constraints
98+
#### Interpoint constraints
8699

87-
The constraints discussed in the previous paragraph belong to the class of so-called
88-
"intrapoint constraints". That is, they impose conditions on each individual point of a batch.
89-
In contrast to this, interpoint constraints do so **across** the points of the batch.
90-
That is, an interpoint constraint of the form ``x + y <= 1`` technically encodes
100+
In contrast to the intrapoint constrains discussed in the previous paragraph,
101+
interpoint constraints models constraints **across** the points of the batch.
102+
That is, an interpoint constraint of the form $x + y <= 1$ encodes
91103
$$
92104
\sum_{i\text{ in batch}}x_i + \sum_{i\text{ in batch}}y_i <= 1
93105
$$
106+
107+
They can be defined by using the `interpoint` argument of the
108+
[`ContinuousLinearConstraint`](baybe.constraints.continuous.ContinuousLinearConstraint)
109+
class.
110+
94111
A possible relevant constraint might be that only 100ml of a given solvent are available for
95112
a full batch.
96113

97-
They can be defined by using the `interpoint` argument of the [`ContinuousLinearConstraint`](baybe.constraints.continuous.ContinuousLinearConstraint)
98-
class.
114+
99115
```python
100116
from baybe.constraints import ContinuousLinearConstraint
101117

0 commit comments

Comments
 (0)