Skip to content

Commit

Permalink
Start adaptation of Braning (docstring)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhernandezgarcia committed May 28, 2024
1 parent 92d45b7 commit a21d42f
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions gflownet/proxy/box/branin.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
X2_DOMAIN). Setting do_domain_map to False will prevent the mapping.
Branin function is typically used as a minimization problem, with the minima around
zero but positive. In order to map the range into the convential negative range, an
upper bound of of Branin in the standard domain (UPPER_BOUND_IN_DOMAIN) is subtracted.
zero but positive. This is the convention followed by default, therefore the user
should carefully select the reward function.
"""

import torch
Expand All @@ -29,9 +29,15 @@
class Branin(Proxy):
def __init__(self, fidelity=1.0, do_domain_map=True, **kwargs):
"""
Parameters
----------
fidelity : float
Fidelity of the Branin oracle. 1.0 corresponds to the original Branin.
Smaller values (up to 0.0) reduce the fidelity of the oracle.
do_domain_map : bool
If True, the states are assumed to be in [0, 1] x [0, 1] and are re-mapped
to the standard domain before calling the botorch method. If False, the
botorch method is called directly on the states values.
See: https://botorch.org/api/test_functions.html
"""
Expand Down

0 comments on commit a21d42f

Please sign in to comment.