From 53f0ac9ffda7051841fb5f505113fa4c719a7eae Mon Sep 17 00:00:00 2001 From: Thomas Hirtz Date: Tue, 12 Nov 2024 09:13:10 +0100 Subject: [PATCH] update docstrings --- jumanji/types.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/jumanji/types.py b/jumanji/types.py index c104114e2..249851846 100644 --- a/jumanji/types.py +++ b/jumanji/types.py @@ -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. @@ -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. @@ -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. @@ -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. """