From 35d814fe73c2becb57d834ef9c23d6a179ef755c Mon Sep 17 00:00:00 2001 From: Jiayi Zhou <108712610+Gaiejj@users.noreply.github.com> Date: Fri, 25 Aug 2023 05:05:28 +0800 Subject: [PATCH] docs: refine README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cfdd081..b67c6a6 100644 --- a/README.md +++ b/README.md @@ -152,8 +152,8 @@ For more details, please refer to [Safety-Gymnasium](https://github.com/PKU-Alig - **❗️As Safe MultiGoal and Safe Isaac Gym tasks have not been uploaded in PyPI due to too large package size, please install [Safety-Gymnasium](https://github.com/PKU-Alignment/safety-gymnasium) manually to run those two tasks, by using following commands:** ```bash -conda create -n safe python=3.8 -conda activate safe +conda create -n safepo python=3.8 +conda activate safepo wget https://github.com/PKU-Alignment/safety-gymnasium/archive/refs/heads/main.zip unzip main.zip cd safety-gymnasium-main @@ -179,8 +179,8 @@ To use SafePO-Baselines, you need to install environments. Please refer to [Safe ## Conda-Environment ```bash -conda create -n safe python=3.8 -conda activate safe +conda create -n safepo python=3.8 +conda activate safepo # because the cuda version, we recommend you install pytorch manual. pip install -e . ``` @@ -205,14 +205,14 @@ conda activate safepo make simple-benchmark ``` -These commands will run all algorithms in sampled environments to get +The above commands will run all algorithms in sampled environments to get a quick overview of the performance of the algorithms. **Please notice that these commands would reinstall Safety-Gymnasium from PyPI. -To run Safe Isaac Gym and Safe Multi Goal, please reinstall it manully from source by:** +To run Safe Isaac Gym and Safe MultiGoal, please reinstall it manully from source by:** ```bash -conda activate safe +conda activate safepo wget https://github.com/PKU-Alignment/safety-gymnasium/archive/refs/heads/main.zip unzip main.zip cd safety-gymnasium-main