Add Shimmy wrappers to docs

ronaldluc · Aug 16, 2023 · 5f37d44 · 5f37d44
1 parent eed5ea7
commit 5f37d44
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/source/api/envs.rst b/docs/source/api/envs.rst
@@ -69,3 +69,6 @@ In addition, you will be able to :doc:`wrap single-agent <envs/wrapping>` and :d
     * - robosuite
       - .. centered:: :math:`\blacksquare`
       - .. centered:: :math:`\square`
+    * - Shimmy
+      - .. centered:: :math:`\blacksquare`
+      - .. centered:: :math:`\blacksquare`
diff --git a/docs/source/api/envs/wrapping.rst b/docs/source/api/envs/wrapping.rst
@@ -10,6 +10,7 @@ Wrapping (single-agent)
 This library works with a common API to interact with the following RL environments:
 
 * OpenAI `Gym <https://www.gymlibrary.dev>`_ / Farama `Gymnasium <https://gymnasium.farama.org/>`_ (single and vectorized environments)
+* `Farama Shimmy <https://shimmy.farama.org/>`_
 * `DeepMind <https://github.com/deepmind/dm_env>`_
 * `robosuite <https://robosuite.ai/>`_
 * `NVIDIA Isaac Gym <https://developer.nvidia.com/isaac-gym>`_ (preview 2, 3 and 4)
@@ -265,6 +266,24 @@ Usage
                                     :start-after: [jax-start-gymnasium-vectorized]
                                     :end-before: [jax-end-gymnasium-vectorized]
 
+    .. tab:: Shimmy
+
+        .. tabs::
+
+            .. group-tab:: |_4| |pytorch| |_4|
+
+                .. literalinclude:: ../../snippets/wrapping.py
+                    :language: python
+                    :start-after: [pytorch-start-shimmy]
+                    :end-before: [pytorch-end-shimmy]
+
+            .. group-tab:: |_4| |jax| |_4|
+
+                .. literalinclude:: ../../snippets/wrapping.py
+                    :language: python
+                    :start-after: [jax-start-shimmy]
+                    :end-before: [jax-end-shimmy]
+
     .. tab:: DeepMind
 
         .. tabs::