Skip to content

Commit

Permalink
Merge pull request #1 from AVHopp/docs/post_0.7.0_link_fix
Browse files Browse the repository at this point in the history
Docs/post 0.7.0 link fix
  • Loading branch information
AVHopp authored Dec 5, 2023
2 parents 6064dcf + eca7378 commit 29d1e22
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ we recommend the following workflow:
There are several test environments you can run via `tox`, each corresponding to a
[developer tool](#developer-tools) in a certain Python version.
You can retrieve all available environments via `tox list`.
For more information, see our [README about tests](tests/README.md).
For more information, see our [README about tests](https://github.com/emdgroup/baybe/blob/main/tests/README.md).
For instance, running all code tests in Python 3.11 can be achieved via:
```console
Expand All @@ -70,6 +70,7 @@ we recommend the following workflow:

1. Open a pull request via Github's web page.

(developer-tools)=
## Developer Tools

In order to maintain a high code quality, we use a variety of code developer tools.
Expand Down Expand Up @@ -98,7 +99,7 @@ tox -e <env>
```
where `<env>` is any of the environment names found via `tox list`.


(code-design)=
## Code Design

When reading BayBE's code, you will notice certain re-occurring design patterns.
Expand All @@ -121,7 +122,7 @@ make sure that the newly written code is well integrated into the existing packa
module hierarchy.
In particular, public functionality should be imported into the appropriate high-level
namespaces for easier user import. For an example, see our
[parameter namespace](baybe/parameters/__init__.py).
[parameter namespace](https://github.com/emdgroup/baybe/blob/main/baybe/parameters/__init__.py).

## Writing Docstrings

Expand Down
2 changes: 1 addition & 1 deletion docs/userguide/campaigns.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ series of measurements and the iterative sequence of events involved.
To construct a new campaign, it is necessary to provide two objects.
1. **A search space:** The parameter space in which the campaign operates. It can be a purely discrete, purely continuous or hybir space.
We refer to the [`Searchspace`](baybe.searchspace.core.SearchSpace) class resp. the corresponding [user guide](./searchspace) for more details.
2. **An objective:** The optimization objective. It is possible to either optimize a single target or to combine different targets. We refer to the [`Objective`](baybe.objective.Objective) class resp. the corresponding [user guide](./objectives) for more details.
2. **An objective:** The optimization objective. It is possible to either optimize a single target or to combine different targets. We refer to the [`Objective`](baybe.objective.Objective) class resp. the corresponding [user guide](./objective) for more details.

The following additional aspects are available to further specify a campaign:
* **A strategy:**: The strategy that is used during the campaign. As a default, a [`TwoPhaseStrategy`](baybe.strategies.composite.TwoPhaseStrategy) is employed. For more details on strategies, see [here](./strategy).
Expand Down
5 changes: 3 additions & 2 deletions docs/userguide/constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Not all surrogate models are able to treat continuous constraints. In such situa
the constraints are currently silently ignored.
```

(CLEQ)=
### ``ContinuousLinearEqualityConstraint``
This linear constraint asserts that the following equation is true (up to numerical
rounding errors):
Expand Down Expand Up @@ -68,7 +69,7 @@ both sides, i.e. the coefficients and rhs, by -1.
```

Let us amend the example from
[`ContinuousLinearEqualityConstraint`](#continuouslinearequalityconstraint) and assume
[`ContinuousLinearEqualityConstraint`](#CLEQ) and assume
that there is always a fourth component to the mixture which serves as a "filler".
In such a case we might want to ensure that the first three components only make up to
80% of the mixture.
Expand Down Expand Up @@ -147,7 +148,7 @@ DiscreteExcludeConstraint(

### ``DiscreteSumConstraint`` and ``DiscreteProductConstraint``
These constraints constrain sums or products of numerical parameters. In the example
from [``ContinuousLinearEqualityConstraint``](#continuouslinearequalityconstraint) we
from [``ContinuousLinearEqualityConstraint``](#CLEQ) we
had three continuous parameters ``x_1``, ``x_2`` and ``x_3`` which needed to sum
up to 1.0.
If these parameters were instead discrete, the corresponding constraint would look like:
Expand Down

0 comments on commit 29d1e22

Please sign in to comment.