Skip to content

Fixes dummy agent path in template docs #3698

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+46 −6
Open

Fixes dummy agent path in template docs #3698

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1111111
corrects template doc
louislelay Oct 14, 2025
89d4126
Merge branch 'main' into louis/fix-template-doc
ooctipus Oct 15, 2025
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
52 changes: 46 additions & 6 deletions docs/source/overview/own-project/template.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,48 @@ Here are some general commands to get started with it:

python scripts\<specific-rl-library>\train.py --task=<Task-Name>

* Run a task with dummy agents.

These include dummy agents that output zero or random agents. They are useful to ensure that the environments are configured correctly.

* Zero-action agent

.. tab-set::
:sync-group: os

.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux

.. code-block:: bash

python scripts/zero_agent.py --task=<Task-Name>

.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows

.. code-block:: batch

python scripts\zero_agent.py --task=<Task-Name>

* Random-action agent

.. tab-set::
:sync-group: os

.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux

.. code-block:: bash

python scripts/random_agent.py --task=<Task-Name>

.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows

.. code-block:: batch

python scripts\random_agent.py --task=<Task-Name>

For more details, please follow the instructions in the generated project's ``README.md`` file.

Internal task usage (once generated)
Expand Down Expand Up @@ -189,8 +231,6 @@ Here are some general commands to get started with it:

* Run a task with dummy agents.

These include dummy agents that output zero or random agents. They are useful to ensure that the environments are configured correctly.

* Zero-action agent

.. tab-set::
Expand All @@ -201,14 +241,14 @@ Here are some general commands to get started with it:

.. code-block:: bash

python scripts/zero_agent.py --task=<Task-Name>
python scripts/environments/zero_agent.py --task=<Task-Name>

.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows

.. code-block:: batch

python scripts\zero_agent.py --task=<Task-Name>
python scripts\environments\zero_agent.py --task=<Task-Name>

* Random-action agent

Expand All @@ -220,11 +260,11 @@ Here are some general commands to get started with it:

.. code-block:: bash

python scripts/random_agent.py --task=<Task-Name>
python scripts/environments/random_agent.py --task=<Task-Name>

.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows

.. code-block:: batch

python scripts\random_agent.py --task=<Task-Name>
python scripts\environments\random_agent.py --task=<Task-Name>