diff --git a/omnisafe/adapter/offline_adapter.py b/omnisafe/adapter/offline_adapter.py index fddd56af3..223025a8b 100644 --- a/omnisafe/adapter/offline_adapter.py +++ b/omnisafe/adapter/offline_adapter.py @@ -102,6 +102,10 @@ def reset( ) -> tuple[torch.Tensor, dict[str, Any]]: """Reset the environment and returns an initial observation. + Args: + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. + Returns: observation: The initial observation of the space. info: Some information logged by the environment. diff --git a/omnisafe/adapter/online_adapter.py b/omnisafe/adapter/online_adapter.py index 6d3671f4e..816de8456 100644 --- a/omnisafe/adapter/online_adapter.py +++ b/omnisafe/adapter/online_adapter.py @@ -170,6 +170,10 @@ def reset( ) -> tuple[torch.Tensor, dict[str, Any]]: """Reset the environment and returns an initial observation. + Args: + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. + Returns: observation: The initial observation of the space. info: Some information logged by the environment. diff --git a/omnisafe/adapter/saute_adapter.py b/omnisafe/adapter/saute_adapter.py index d67d2cd57..95a136605 100644 --- a/omnisafe/adapter/saute_adapter.py +++ b/omnisafe/adapter/saute_adapter.py @@ -119,6 +119,10 @@ def reset( .. note:: Additionally, the safety observation will be reset. + Args: + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. + Returns: observation: The initial observation of the space. info: Some information logged by the environment. diff --git a/omnisafe/adapter/simmer_adapter.py b/omnisafe/adapter/simmer_adapter.py index 1f345439e..6fb8c5421 100644 --- a/omnisafe/adapter/simmer_adapter.py +++ b/omnisafe/adapter/simmer_adapter.py @@ -99,6 +99,10 @@ def reset( Additionally, the safety observation will be reset. And the safety budget will be reset to the value of current ``rel_safety_budget``. + Args: + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. + Returns: observation: The initial observation of the space. info: Some information logged by the environment. diff --git a/omnisafe/envs/core.py b/omnisafe/envs/core.py index f30422e70..999ac45fe 100644 --- a/omnisafe/envs/core.py +++ b/omnisafe/envs/core.py @@ -132,7 +132,8 @@ def reset( """Reset the environment and returns an initial observation. Args: - seed (int or None): Seed for the environment. Defaults to None. + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. Returns: observation: The initial observation of the space. @@ -249,7 +250,9 @@ def reset( """Reset the environment and returns an initial observation. Args: - seed (int or None): Seed for the environment. Defaults to None. + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. + Returns: observation: The initial observation of the space. diff --git a/omnisafe/envs/mujoco_env.py b/omnisafe/envs/mujoco_env.py index dbe0f42ab..cdedfb29a 100644 --- a/omnisafe/envs/mujoco_env.py +++ b/omnisafe/envs/mujoco_env.py @@ -150,7 +150,8 @@ def reset( """Reset the environment. Args: - seed (int, optional): Seed to reset the environment. Defaults to None. + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. Returns: observation: Agent's observation of the current environment. diff --git a/omnisafe/envs/safety_gymnasium_env.py b/omnisafe/envs/safety_gymnasium_env.py index 6bd821a32..f9eb75d20 100644 --- a/omnisafe/envs/safety_gymnasium_env.py +++ b/omnisafe/envs/safety_gymnasium_env.py @@ -217,8 +217,9 @@ def reset( """Reset the environment. Args: - seed (int or None, optional): Seed to reset the environment. - Defaults to None. + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. + Returns: observation: Agent's observation of the current environment. diff --git a/omnisafe/envs/safety_gymnasium_modelbased.py b/omnisafe/envs/safety_gymnasium_modelbased.py index f8f3ee446..3edc7584b 100644 --- a/omnisafe/envs/safety_gymnasium_modelbased.py +++ b/omnisafe/envs/safety_gymnasium_modelbased.py @@ -473,7 +473,9 @@ def reset( """Reset the environment. Args: - seed (int, optional): Seed to reset the environment. Defaults to None. + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. + Returns: observation: The initial observation of the space. diff --git a/omnisafe/envs/wrapper.py b/omnisafe/envs/wrapper.py index 9bf3f0cca..c4b8bce89 100644 --- a/omnisafe/envs/wrapper.py +++ b/omnisafe/envs/wrapper.py @@ -63,7 +63,8 @@ def reset( Additionally, the time step will be reset to 0. Args: - seed (int or None, optional): The seed for the environment. Defaults to None. + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. Returns: observation: The initial observation of the space. @@ -247,7 +248,8 @@ def reset( """Reset the environment and returns an initial observation. Args: - seed (int or None, optional): Seed for the environment. Defaults to None. + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. Returns: observation: The initial observation of the space. @@ -633,7 +635,8 @@ def reset( The vector information will be unsqueezed to (1, dim) for agent training. Args: - seed (int or None, optional): Set the seed for the environment. Defaults to None. + seed (int, optional): The random seed. Defaults to None. + options (dict[str, Any], optional): The options for the environment. Defaults to None. Returns: observation: The initial observation of the space.