docs: polish documents

PKU-Alignment · Aug 21, 2023 · 7f80875 · 7f80875
2 parents 3111796 + 6d91db5
commit 7f80875
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -208,6 +208,8 @@ cd safepo/multi_agent
 python macpo.py --task ShadowHandOver_Safe_joint --experiment benchmark
 ```
 
+**As Isaac Gym is holding in PyPI, you should install it manually, then clone [Safety-Gymnasium](https://github.com/PKU-Alignment/safety-gymnasium) instead of installing from PyPI.**
+
 **Note**: The default value for ``task`` is ``MujucoVelocity``. The default scenrio is ``Ant`` while the default agent configuration is ``2x4``. You can run other agent or scenrio by:
 
 ```bash

diff --git a/docs/source/usage/train.rst b/docs/source/usage/train.rst
@@ -11,7 +11,7 @@ To run the algorithms with default configuration, you need to specify the enviro
 .. code-block:: bash
 
     cd safepo/single_agent
-    python ppo_lag.py --env-id SafetyPointGoal1-v0 --experiment ppo_lag_exp
+    python ppo_lag.py --task SafetyPointGoal1-v0 --experiment ppo_lag_exp
 
 Then you can check the results in the ``runs/ppo_lag_exp`` folder.
 
@@ -50,7 +50,7 @@ We provide the detailed description of the command line arguments in the followi
         | --total-steps      | Total timesteps of the           | 10000000                                      |
         |                    | experiments                      |                                               |
         +--------------------+----------------------------------+-----------------------------------------------+
-        | --env-id           | ID of the environment            | "SafetyPointGoal1-v0"                         |
+        | --task           | ID of the environment            | "SafetyPointGoal1-v0"                         |
         +--------------------+----------------------------------+-----------------------------------------------+
         | --use-eval         | Toggles evaluation               | False                                         |
         +--------------------+----------------------------------+-----------------------------------------------+