From cf0a7a3eceb4434bba32be653f70a0d3e331ef47 Mon Sep 17 00:00:00 2001 From: Rick Staa Date: Fri, 19 Jan 2024 11:42:42 +0100 Subject: [PATCH] docs: fix SAC alg run command (#380) This commit fixes a typo in the SAC run command given in the documentation. --- docs/source/usage/running.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/usage/running.rst b/docs/source/usage/running.rst index 221161bd1..ab5fdf9c7 100644 --- a/docs/source/usage/running.rst +++ b/docs/source/usage/running.rst @@ -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. @@ -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``.)