Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ahalev committed Aug 9, 2024
1 parent 8bf5317 commit cd70af0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/pymgrid/microgrid/microgrid.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ def step(self, control, normalized=True):
Parameters
----------
control : dict[str, list[float]]
control : dict[str, np.typing.arrayLike]
Actions to pass to each fixed module.
normalized : bool, default True
Whether ``control`` is a normalized value or not. If not, each module de-normalizes its respective action.
Expand Down
2 changes: 1 addition & 1 deletion src/pymgrid/modules/grid_module.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class GridModule(BaseTimeSeriesMicrogridModule):
If n_features=4, time series of ``(import_price, export_price, co2_per_kwH, grid_status)``
in each column, respectively. ``time_series[:, -1]`` -- the grid status -- must be binary.
forecaster : callable, float, "oracle", or None, default None.
forecaster : callable, float, "oracle", None, default None.
Function that gives a forecast n-steps ahead.
* If ``callable``, must take as arguments ``(val_c: float, val_{c+n}: float, n: int)``, where
Expand Down

0 comments on commit cd70af0

Please sign in to comment.