Skip to content
This repository was archived by the owner on May 6, 2021. It is now read-only.

Commit 6ac4170

Browse files
authored
Update README.md (#105)
1 parent 22d500f commit 6ac4170

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ If you are looking for tabular reinforcement learning algorithms, you may refer
3232

3333
# Built-in Experiments
3434

35-
Some built-in experiments are exported to help new users to easily run benchmarks with one line (for example, ``run(E`JuliaRL_BasicDQN_CartPole`)``). For experienced users, you are suggested to check [the source code](https://github.com/JuliaReinforcementLearning/ReinforcementLearningZoo.jl/tree/master/src/experiments) of those experiments and make changes as needed.
35+
Some built-in experiments are exported to help new users to easily run benchmarks with one line. For experienced users, you are suggested to check [the source code](https://github.com/JuliaReinforcementLearning/ReinforcementLearningZoo.jl/tree/master/src/experiments) of those experiments and make changes as needed.
3636

3737
## List of built-in experiments
3838

@@ -62,6 +62,26 @@ Some built-in experiments are exported to help new users to easily run benchmark
6262
- ``E`rlpyt_A2C_Atari(pong)` ``
6363
- ``E`rlpyt_PPO_Atari(pong)` ``
6464

65+
## Run Experiments
66+
67+
```julia
68+
julia> ] add ReinforcementLearningZoo
69+
70+
julia> using ReinforcementLearningZoo
71+
72+
julia> ] add ReinforcementLearningEnvironments
73+
74+
julia> using ReinforcementLearningEnvironments
75+
76+
julia> run(E`JuliaRL_BasicDQN_CartPole`) # the CartPole environment is provided in ReinforcementLearningEnvironments, so we need to have it installed first
77+
78+
julia> ] add ArcadeLearningEnvironment
79+
80+
julia> using ArcadeLearningEnvironment
81+
82+
julia> run(E`rlpyt_PPO_Atari(pong)`) # the Atari environment is provided in ArcadeLearningEnvironment, so we need to install it first
83+
```
84+
6585
### Notes:
6686

6787
- Experiments on `CartPole` usually run faster with CPU only due to the overhead of sending data between CPU and GPU.

0 commit comments

Comments
 (0)