Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamc committed Aug 9, 2023
1 parent ea34f2e commit 8b4a7e5
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions carl/envs/carl_env.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ def __init__(
env: Env,
contexts: Contexts | None = None,
obs_context_features: list[str]
| None = None, # list the context features which should be added to the state
| None = None,
obs_context_as_dict: bool = True,
context_selector: AbstractSelector | type[AbstractSelector] | None = None,
context_selector_kwargs: dict = None,
context_selector_kwargs: dict | None = None,
**kwargs,
):
"""Base CARL wrapper.
Expand All @@ -39,7 +39,23 @@ def __init__(
Parameters
----------
# TODO add docstring for carl env params
env : Env
Environment adhering to gymnasium API.
contexts : Contexts, optional
The context set, by default None.
obs_context_features : list[str], optional
The context features which should be added to the state, by default None. If None,
add all available context features.
obs_context_as_dict : bool, optional
Whether to pass the context as a vector or a dict in the observations.
The default is True.
context_selector : AbstractSelector | type[AbstractSelector] | None
The context selector selecting a new context after each env reset, by default None.
If None, use a round robin selector. Can be an object or class. For the latter,
you can pass kwargs.
context_selector_kwargs : dict, optional
Keyword arguments for the context selector if it is passed as a class.
Attributes
----------
Expand Down

0 comments on commit 8b4a7e5

Please sign in to comment.