diff --git a/docs/index.md b/docs/index.md index fb6d56ff..f1d24905 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,6 +11,7 @@ lastpage: introduction/install introduction/api wrappers/wrappers +wrappers/vector_wrappers examples/morl_baselines ``` diff --git a/docs/wrappers/vector_wrappers.md b/docs/wrappers/vector_wrappers.md new file mode 100644 index 00000000..ade24022 --- /dev/null +++ b/docs/wrappers/vector_wrappers.md @@ -0,0 +1,20 @@ +--- +title: "Vector Wrappers" +--- + +# Vector Wrappers + +Similar to the normal wrappers, MO-Gymnasium provides a few wrappers that are specifically designed to work with vectorized environments. They are all available directly from the `mo_gymnasium.wrappers.vector` module. + + +## `MOSyncVectorEnv` + +```{eval-rst} +.. autoclass:: mo_gymnasium.wrappers.vector.MOSyncVectorEnv +``` + +## `MORecordEpisodeStatistics` + +```{eval-rst} +.. autoclass:: mo_gymnasium.wrappers.vector.MORecordEpisodeStatistics +``` diff --git a/docs/wrappers/wrappers.md b/docs/wrappers/wrappers.md index 5d6bd55d..acf2ab56 100644 --- a/docs/wrappers/wrappers.md +++ b/docs/wrappers/wrappers.md @@ -4,7 +4,7 @@ title: "Wrappers" # Wrappers -A few wrappers inspired from Gymnasium's wrappers are available in MO-Gymnasium. They are all available directly from the `mo_gymnasium` module. +A few wrappers inspired from Gymnasium's wrappers are available in MO-Gymnasium. They are all available directly from the `mo_gymnasium.wrappers` module. ## `LinearReward` @@ -26,14 +26,14 @@ A few wrappers inspired from Gymnasium's wrappers are available in MO-Gymnasium. .. autoclass:: mo_gymnasium.wrappers.MOClipReward ``` -## `MOSyncVectorEnv` +## `MORecordEpisodeStatistics` ```{eval-rst} -.. autoclass:: mo_gymnasium.wrappers.MOSyncVectorEnv +.. autoclass:: mo_gymnasium.wrappers.MORecordEpisodeStatistics ``` -## `MORecordEpisodeStatistics` +## `MOMaxAndSkipObservation` ```{eval-rst} -.. autoclass:: mo_gymnasium.wrappers.MORecordEpisodeStatistics +.. autoclass:: mo_gymnasium.wrappers.MOMaxAndSkipObservation ``` diff --git a/mo_gymnasium/__init__.py b/mo_gymnasium/__init__.py index f49af753..a238e5cd 100644 --- a/mo_gymnasium/__init__.py +++ b/mo_gymnasium/__init__.py @@ -2,6 +2,7 @@ # Envs import mo_gymnasium.envs +from mo_gymnasium import wrappers # Utils from mo_gymnasium.utils import make diff --git a/mo_gymnasium/wrappers/__init__.py b/mo_gymnasium/wrappers/__init__.py index e77291a4..274241a0 100644 --- a/mo_gymnasium/wrappers/__init__.py +++ b/mo_gymnasium/wrappers/__init__.py @@ -1,5 +1,6 @@ """Contains all wrappers (vectors or not).""" +from mo_gymnasium.wrappers import vector from mo_gymnasium.wrappers.wrappers import ( LinearReward, MOClipReward,