Skip to content

Commit ff93cfc

Browse files
authored
Add API overview diagram to user guide (#597)
2 parents 0f84f3c + 0d061c3 commit ff93cfc

5 files changed

Lines changed: 30 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
8+
### Added
9+
- API diagram in user guide
10+
811
### Fixed
912
- `Campaign` no longer allows overlapping names between parameters and targets
1013

CONTRIBUTORS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
- Julian Streibel (Merck Life Science KGaA, Darmstadt, Germany):\
2828
Bernoulli multi-armed bandit and Thompson sampling
2929
- Karin Hrovatin (Merck KGaA, Darmstadt, Germany):\
30-
`scikit-fingerprints` support
30+
`scikit-fingerprints` support, API overview diagram
3131
- Fabian Liebig (Merck KGaA, Darmstadt, Germany):\
3232
Benchmarking structure and persistence capabilities for benchmarking results
3333
- Alexander Wieczorek (Swiss Federal Institute for Materials Science and Technology, Dübendorf, Switzerland):\

docs/_static/api_overview_dark.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/_static/api_overview_light.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/userguide/userguide.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# User Guide
22

3+
The most commonly used interface BayBE provides is the central
4+
[`Campaign`](baybe.campaign.Campaign) object,
5+
which suggests new measurements and administers the current state of
6+
your experimental operation. The diagram below explains how the
7+
[`Campaign`](baybe.campaign.Campaign) can be used to perform
8+
the bayesian optimization loop, how it can be configured and
9+
how the results can be post-analysed.
10+
11+
```{image} ../_static/api_overview_dark.svg
12+
:align: center
13+
:class: only-dark
14+
```
15+
16+
```{image} ../_static/api_overview_light.svg
17+
:align: center
18+
:class: only-light
19+
```
20+
21+
Detailed examples of how to use individual API components can be found below:
22+
323
```{toctree}
424
Getting Recommendations <getting_recommendations>
525
Campaigns <campaigns>

0 commit comments

Comments
 (0)