From 38dab5e05e71f0a087533a79e0aeac3b366bd672 Mon Sep 17 00:00:00 2001 From: Arshia Ilaty <58371460+ArshiaIlaty@users.noreply.github.com> Date: Thu, 5 Dec 2024 02:33:56 -0800 Subject: [PATCH] Adding links to the tutorials section #1256 (#1266) --- docs/tutorials/README.rst | 5 +++++ docs/tutorials/gymnasium_basics/README.rst | 11 ++++++++++- docs/tutorials/training_agents/README.rst | 9 +++++++-- 3 files changed, 22 insertions(+), 3 deletions(-) diff --git a/docs/tutorials/README.rst b/docs/tutorials/README.rst index 0c7e28c3b..dabb3ea13 100644 --- a/docs/tutorials/README.rst +++ b/docs/tutorials/README.rst @@ -1,2 +1,7 @@ Tutorials ========= +In this section, we cover some of the most well-known benchmarks of RL including the Frozen Lake, Black Jack, and Training using REINFORCE for Mujoco. + +Additionally, we provide a guide on how to load custom quadruped robot environments, implementing custom wrappers, creating custom environments, handling time limits, and training A2C with Vector Envs and Domain Randomization. + +Lastly, there is a guide on third-party integrations with Gymnasium. diff --git a/docs/tutorials/gymnasium_basics/README.rst b/docs/tutorials/gymnasium_basics/README.rst index c11f273cf..ea5621b33 100644 --- a/docs/tutorials/gymnasium_basics/README.rst +++ b/docs/tutorials/gymnasium_basics/README.rst @@ -1,5 +1,14 @@ -Gymnasium Basics +Gymnasium Basics Documentation Links ---------------- +Load custom quadruped robot environments link: https://gymnasium.farama.org/tutorials/gymnasium_basics/load_quadruped_model/ + +Implementing Custom Wrappers link: https://gymnasium.farama.org/tutorials/gymnasium_basics/implementing_custom_wrappers/ + +Make your own custom environment(environment_creation.py): https://gymnasium.farama.org/tutorials/gymnasium_basics/environment_creation/ + +Handling Time Limits: https://gymnasium.farama.org/tutorials/gymnasium_basics/handling_time_limits/ + +Training A2C with Vector Envs and Domain Randomization: https://gymnasium.farama.org/tutorials/gymnasium_basics/vector_envs_tutorial/ .. toctree:: :hidden: diff --git a/docs/tutorials/training_agents/README.rst b/docs/tutorials/training_agents/README.rst index b203cce35..580e16a48 100644 --- a/docs/tutorials/training_agents/README.rst +++ b/docs/tutorials/training_agents/README.rst @@ -1,2 +1,7 @@ -Training Agents ---------------- +Training Agents links in the Gymnasium Documentation +----------------------------------------------------- +Solving Blackjack with Q-Learning link: https://gymnasium.farama.org/tutorials/training_agents/blackjack_tutorial/ + +Frozen Lake Benchmark link: https://gymnasium.farama.org/tutorials/training_agents/FrozenLake_tuto/ + +Training using REINFORCE for Mujoco link: https://gymnasium.farama.org/tutorials/training_agents/reinforce_invpend_gym_v26/