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.

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

docs: fix SAC alg run command #380

Merged
merged 1 commit into from
Jan 19, 2024
Merged

docs: fix SAC alg run command #380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/source/usage/running.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ eg:
--hid[h] [32,32] [64,32] --act torch.nn.Tanh --seed 0 10 20 --dt
--data_dir path/to/data

runs SAC in the ``Ant-v4`` gymnasium environment, with various settings controlled by the flags.
runs the SAC algorithm in the ``Ant-v4`` gymnasium environment, with various settings controlled by the flags.

By default, the PyTorch version will run. You can, however, substitute ``sac`` with
``sac_tf2`` for the TensorFlow version.
Expand Down Expand Up @@ -146,7 +146,7 @@ to see a readout of the docstring.

.. parsed-literal::

python -m stable_learning_control.run SAC --env Walker2d-v4 --exp_name walker --act torch.nn.ReLU
python -m stable_learning_control.run sac --env Walker2d-v4 --exp_name walker --act torch.nn.ReLU

sets ``torch.nn.ReLU`` as the activation function. (TensorFlow equivalent: run ``sac_tf`` with ``--act tf.nn.relu``.)

Expand Down