From 567a6d10dc7ebfa5e2fe4cac329bd04b61d7984b Mon Sep 17 00:00:00 2001 From: AdrianSosic Date: Thu, 18 Apr 2024 16:12:04 +0200 Subject: [PATCH] Rename objective.md to objectives.md This reverts commit 32483d82bd14256656d8695d8bf0ab2db80c09d1. --- README.md | 2 +- docs/userguide/campaigns.md | 2 +- docs/userguide/{objective.md => objectives.md} | 0 docs/userguide/targets.md | 2 +- docs/userguide/userguide.md | 2 +- examples/Multi_Target/Multi_Target_Header.md | 2 +- 6 files changed, 5 insertions(+), 5 deletions(-) rename docs/userguide/{objective.md => objectives.md} (100%) diff --git a/README.md b/README.md index 1a59e1c25..4194937f1 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/userguide/campaigns.md b/docs/userguide/campaigns.md index 67fb58d1a..5d72f0a6b 100644 --- a/docs/userguide/campaigns.md +++ b/docs/userguide/campaigns.md @@ -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 diff --git a/docs/userguide/objective.md b/docs/userguide/objectives.md similarity index 100% rename from docs/userguide/objective.md rename to docs/userguide/objectives.md diff --git a/docs/userguide/targets.md b/docs/userguide/targets.md index 74c2960b0..99f8bab89 100644 --- a/docs/userguide/targets.md +++ b/docs/userguide/targets.md @@ -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) diff --git a/docs/userguide/userguide.md b/docs/userguide/userguide.md index 6a5a9470e..b6983aa08 100644 --- a/docs/userguide/userguide.md +++ b/docs/userguide/userguide.md @@ -3,7 +3,7 @@ ```{toctree} Campaigns Constraints -Objective +Objectives Parameters Recommenders Search Spaces diff --git a/examples/Multi_Target/Multi_Target_Header.md b/examples/Multi_Target/Multi_Target_Header.md index fb87f4a87..48e9287e3 100644 --- a/examples/Multi_Target/Multi_Target_Header.md +++ b/examples/Multi_Target/Multi_Target_Header.md @@ -1,4 +1,4 @@ # Multi Target These examples demonstrate BayBE's -{doc}`Multi-Target Capabilities `. \ No newline at end of file +{doc}`Multi-Target Capabilities `. \ No newline at end of file