Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add ros-gazebo-gym positive reward comment #315

Merged
merged 1 commit into from
Aug 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
"gymnasium": ("https://gymnasium.farama.org/%s", None),
"gymnasium-robotics": ("https://robotics.farama.org/%s", None),
"PyFlyt": ("https://jjshoots.github.io/PyFlyt/documentation%s", None),
"stable_learning_control": (
"stable-learning-control": (
"https://github.com/rickstaa/stable-learning-control/%s",
None,
),
Expand Down
8 changes: 5 additions & 3 deletions docs/source/envs/envs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Environments
============

The :stable-gym:`Stable Gym package <>` provides a variety of environments for training and testing
:stable_learning_control:`(stable) reinforcement learning (RL) algorithms <>`.
:stable-learning-control:`(stable) reinforcement learning (RL) algorithms <>`.

Biological environments
-----------------------
Expand Down Expand Up @@ -66,5 +66,7 @@ Robotics environment
./robotics/quadx_waypoints_cost.rst

.. note::
The ROS robotics environments of the Stable Gym package were moved into a separate package
called :ros-gazebo-gym:`Ros Gazebo Gym <>`.
The ROS robotic environments from the Stable Gym package have been relocated to a
distinct package known as :ros-gazebo-gym:`Ros Gazebo Gym <>`. When integrating this package with
stable RL agents, such as those available in the :stable-learning-control:`Stable Learning Control package <>`,
it's crucial to configure the ``positive_reward`` argument as ``True``.
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Welcome to Stable Gym's documentation

The :stable-gym:`Stable Gym <>` package contains several :gymnasium:`gymnasium environments <>`
with cost functions compatible with (stable) RL agents. It was initially created for the stable RL
algorithms in the :stable_learning_control:`Stable Learning Control <>` package but can be
algorithms in the :stable-learning-control:`Stable Learning Control <>` package but can be
used with any RL agent requiring a **positive definite cost function**. For more information about stable
RL agents see the :stable_learning_control:`Stable Learning Control documentation <>`.
RL agents see the :stable-learning-control:`Stable Learning Control documentation <>`.

Contents
========
Expand Down