Update documentation to include list of available install packages

takuseno · Jul 7, 2024 · 294ae1b · 294ae1b
1 parent d1793b9
commit 294ae1b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -135,6 +135,22 @@ Install additional packages::
 
   $ d3rlpy install <name>
 
+.. list-table:: Available package options
+   :header-rows: 1
+
+   * - option
+     - description
+   * - ``atari``
+     - Atari 2600 environments for Gym.
+   * - ``d4rl_atari``
+     - Datasets for Atari 2600. https://github.com/takuseno/d4rl-atari
+   * - ``d4rl``
+     - D4RL.
+   * - ``minari``
+     - Minari.
+   * - ``dm_control``
+     - DeepMind Control environments via Shimmy.
+
 example::
 
   # Install D4RL package

diff --git a/examples/deepmind_control.py b/examples/deepmind_control.py
@@ -5,8 +5,8 @@
 
 import d3rlpy
 
-# You need to install dm_control and Shimmy beforehands as follows:
-# $ d3rlpy install dm-control
+# You need to install DeepMind Control and Shimmy beforehands as follows:
+# $ d3rlpy install dm_control
 
 def main() -> None:
     parser = argparse.ArgumentParser()
@@ -15,7 +15,6 @@ def main() -> None:
     parser.add_argument("--gpu", action="store_true")
     args = parser.parse_args()
 
-    # d3rlpy supports both Gym and Gymnasium
     env_id = f"dm_control/{args.env}"
     env = FlattenObservation(gymnasium.make(env_id))
     eval_env = FlattenObservation(gymnasium.make(env_id))