Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
thomashirtz committed Nov 12, 2024
1 parent 2b92b55 commit 53f0ac9
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions jumanji/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ def restart(
shape: optional parameter to specify the shape of the rewards and discounts.
Allows multi-agent environment compatibility. Defaults to () for
scalar reward and discount.
dtype: Optional parameter to specify the data type of the rewards and discounts.
Defaults to `float`.
Returns:
TimeStep identified as a reset.
Expand Down Expand Up @@ -143,6 +145,8 @@ def transition(
shape: optional parameter to specify the shape of the rewards and discounts.
Allows multi-agent environment compatibility. Defaults to () for
scalar reward and discount.
dtype: Optional parameter to specify the data type of the discounts. Defaults
to `float`.
Returns:
TimeStep identified as a transition.
Expand Down Expand Up @@ -177,6 +181,8 @@ def termination(
shape: optional parameter to specify the shape of the rewards and discounts.
Allows multi-agent environment compatibility. Defaults to () for
scalar reward and discount.
dtype: Optional parameter to specify the data type of the discounts. Defaults
to `float`.
Returns:
TimeStep identified as the termination of an episode.
Expand Down Expand Up @@ -212,6 +218,9 @@ def truncation(
shape: optional parameter to specify the shape of the rewards and discounts.
Allows multi-agent environment compatibility. Defaults to () for
scalar reward and discount.
dtype: Optional parameter to specify the data type of the discounts. Defaults
to `float`.
Returns:
TimeStep identified as the truncation of an episode.
"""
Expand Down

0 comments on commit 53f0ac9

Please sign in to comment.