Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename objective.md to objectives.md #211

Merged
merged 1 commit into from
Apr 23, 2024
Merged

Rename objective.md to objectives.md #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ In cases where we are confronted with multiple (potentially conflicting) targets
the `DesirabilityObjective` can be used instead. It allows to define additional
settings, such as how these targets should be balanced.
For more details, see the
[objective section](https://emdgroup.github.io/baybe/userguide/objective.html)
[objective section](https://emdgroup.github.io/baybe/userguide/objectives.html)
of the user guide.

### Defining the Search Space
Expand Down
2 changes: 1 addition & 1 deletion docs/userguide/campaigns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ describe the underlying optimization problem at hand:

| Campaign Specification | BayBE Class |
|:-------------------------------------------|:------------------------------------------------------------------------------------------|
| What should be optimized in the campaign? | `Objective` ([class](baybe.objectives.base.Objective) / [user guide](./objective)) |
| What should be optimized in the campaign? | `Objective` ([class](baybe.objectives.base.Objective) / [user guide](./objectives)) |
| Which experimental factors can be altered? | `SearchSpace` ([class](baybe.searchspace.core.SearchSpace) / [user guide](./searchspace)) |

Apart from this basic configuration, it is possible to further define the specific
Expand Down
0 docs/userguide/objective.md → docs/userguide/objectives.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/userguide/targets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ experiment and the machine learning core behind BayBE.
In general, it is expected that you create one [`Target`](baybe.targets.base.Target)
object for each of your observables.
The way BayBE treats multiple targets is then controlled via the
[`Objective`](../../userguide/objective).
[`Objective`](../../userguide/objectives).

## NumericalTarget
Besides the `name`, a [`NumericalTarget`](baybe.targets.numerical.NumericalTarget)
Expand Down
2 changes: 1 addition & 1 deletion docs/userguide/userguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
```{toctree}
Campaigns <campaigns>
Constraints <constraints>
Objective <objective>
Objectives <objectives>
Parameters <parameters>
Recommenders <recommenders>
Search Spaces <searchspace>
Expand Down
2 changes: 1 addition & 1 deletion examples/Multi_Target/Multi_Target_Header.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Multi Target

These examples demonstrate BayBE's
{doc}`Multi-Target Capabilities </userguide/objective>`.
{doc}`Multi-Target Capabilities </userguide/objectives>`.
Loading