Skip to content

Commit 1c91d2e

Browse files
authored
Update README.md
1 parent b3ad9de commit 1c91d2e

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,33 @@ Once trained, ADVICE operates by passing the current state and the desired actio
1717
Adaptive ADVICE automatically adjusts the conservativeness of the safety threshold dynamically, based on the agent's recent performance. If the agent has been performing safely, the system can allow more exploratory actions; conversely, if safety violations increase, the system becomes more conservative.
1818

1919
### Getting Started
20-
To get started you can run the `main.py` file from our source code. To run ADVICE in the [safety gymnasium](https://github.com/PKU-Alignment/safety-gymnasium) test suite, it is required you run the following pip command:
20+
To get started you can run the `main.py` file from our source code. To run ADVICE in the [safety gymnasium](https://github.com/PKU-Alignment/safety-gymnasium) test suite, it is required you run the following pip commands:
2121

2222
```
23-
pip install safety-gymnasium
23+
wget https://github.com/PKU-Alignment/safety-gymnasium/archive/refs/heads/main.zip
24+
unzip main.zip
25+
cd safety-gymnasium-main
26+
pip install -e .
2427
```
28+
29+
to locally download the test suite. The following libraries and packages are required:
30+
31+
```
32+
numpy==1.23.4
33+
tensorflow==2.4.1
34+
pandas==2.0.3
35+
plotly==5.18.0
36+
seaborn==0.13.0
37+
scikit-learn==1.2.1
38+
tqdm==4.66.1
39+
```
40+
41+
To then run ADVICE, you can run the `main.py` file using the following command:
42+
43+
```
44+
python main.py
45+
```
46+
2547
You can refer to the [safety gymnasium](https://github.com/PKU-Alignment/safety-gymnasium) repo for more details on installation, usage, and customisation.
2648

2749
### Files

0 commit comments

Comments
 (0)