Skip to content

Commit

Permalink
Rewrite docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
AdrianSosic committed Feb 18, 2025
1 parent 20c4e92 commit 10c71bb
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions baybe/acquisition/acqfs.py
Original file line number Diff line number Diff line change
Expand Up @@ -265,12 +265,12 @@ class UpperConfidenceBound(AcquisitionFunction):
beta: float = field(converter=float, validator=ge(0.0), default=0.2)
"""Trade-off parameter for mean and variance.
* A value of zero makes the acquisition mechanism consider the posterior predictive
mean only, resulting in a risk-neutral behavior.
* Values larger than zero induce risk-seeking behavior, shifting the focus
more and more toward exploration.
* Values smaller than zero lead to favoring risk-averse decisions (a.k.a. "safe
bets"), with purely exploitative behavior in the limit.
* ``beta > 0``: Rewards uncertainty, takes more risk.
Limit ``inf``: Pure exploration
* ``beta < 0``: Punishes uncertainty, takes less risk.
Limit ``-inf``: Pure exploitation
* ``beta = 0``: Discards knowledge about uncertainty, i.e. neither rewards nor
punishes it, is risk-neutral.
"""


Expand Down

0 comments on commit 10c71bb

Please sign in to comment.