Skip to content

Commit

Permalink
Merge pull request #353 from kengz/readme
Browse files Browse the repository at this point in the history
format README
  • Loading branch information
kengz authored May 27, 2019
2 parents 7ee1605 + 45e24ee commit e34cb30
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ SLM Lab integrates with multiple environment offerings:

*Contributions are welcome to integrate more environments!*

#### [Metrics and Experimentation](#experimentation-framework)
### [Metrics and Experimentation](#experimentation-framework)

To facilitate better RL development, SLM Lab also comes with prebuilt *metrics* and *experimentation framework*:
- every run generates metrics, graphs and data for analysis, as well as spec for reproducibility
Expand All @@ -75,7 +75,7 @@ To facilitate better RL development, SLM Lab also comes with prebuilt *metrics*

## Quick Start

### DQN CartPole
#### DQN CartPole

Everything in the lab is ran using a `spec file`, which contains all the information for the run to be reproducible. These are located in `slm_lab/spec/`.

Expand Down Expand Up @@ -103,7 +103,7 @@ This will run a new `Trial` in *training mode*. At the end of it, all the metric
![](https://kengz.gitbooks.io/slm-lab/content/assets/demo_training.png)


### A2C Atari
#### A2C Atari

Run A2C to solve Atari Pong:

Expand All @@ -121,7 +121,7 @@ Below shows a trial graph with multiple sessions:

![](https://kengz.gitbooks.io/slm-lab/content/assets/demo_atari_graph.png)

### Benchmark
#### Benchmark

To run a full benchmark, simply pick a file and run it in train mode. For example, for A2C Atari benchmark, the spec file is `slm_lab/spec/benchmark/a2c/a2c_atari.json`. This file is parametrized to run on a set of environments. Run the benchmark:

Expand All @@ -131,7 +131,7 @@ python run_lab.py slm_lab/spec/benchmark/a2c/a2c_atari.json a2c_atari train

This will spawn multiple processes to run each environment in its separate `Trial`, and the data is saved to `data/` as usual.

### Experimentation / Hyperparameter search
#### Experimentation / Hyperparameter search

An [`Experiment`](https://github.com/kengz/SLM-Lab/blob/master/slm_lab/experiment/control.py) is a hyperparameter search, which samples multiple `spec`s from a search space. `Experiment` spawns a `Trial` for each `spec`, and each `Trial` runs multiple duplicated `Session`s for averaging its results.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "slm_lab",
"version": "2.1.2",
"version": "4.0.0",
"description": "Modular Deep Reinforcement Learning framework in PyTorch.",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit e34cb30

Please sign in to comment.