Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
* single agent RL stuff
* vizdoom training code .yml.jinja2
  • Loading branch information
pengsun committed Dec 11, 2020
1 parent ffa79b3 commit 34636fc
Show file tree
Hide file tree
Showing 4 changed files with 992 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ of how to train ViZDoom in a single machine.
Refer also to the [link here](https://github.com/tencent-ailab/TLeagueVdAutoBuild.git) for how to (auto-)build the docker image,
which is yet-another guide to installation from scratch.

TODO: texts for how to train with k8s
For running training over a k8s cluster, see the [link here](vizdoom/README.md#training-code).

### Pommerman Training
When installing the `Arena` package,
Expand All @@ -87,6 +87,17 @@ TODO: pointer to the Docker Auto Build repo and say it's yet-another guide to in

TODO: texts for how to train with k8s

### Single Agent RL
TLeague also works for pure RL,
which can be viewed as a special case of MARL where the number of agents equals to one.
[Here are examples](https://github.com/tencent-ailab/TLeague/blob/dev-open/docs/EXAMPLE_SM.md#single-agent-rl)
for how to train gym Atari in a single machine.

Ensure the correct dependencies are installed:
```bash
pip install gym[atari]==0.12.1
```

# Disclaimer
This is not an officially supported Tencent product.
The code and data in this repository are for research purpose only.
Expand Down
21 changes: 21 additions & 0 deletions vizdoom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,26 @@ bash MyPlayer/TLeague/tleague/sandbox/example_evaluation_vd.sh evaluation
./run.sh f1
```

## Training Code
As described in the technical reports, there are two stages for training:
one for the navigation, and the other for the frag.
We provide the corresponding `.yml.jinja2` files here: [for navigation](vdtr-navi-open.yml.jinja2) and [for frag](vdtr-frag-open.yml.jinja2), respectively.

Run the training over a k8s cluster:
```bash
# start
python render_template.py vdtr-navi-open.yml.jinja2 | kubectl apply -f -
# stop
python render_template.py vdtr-navi-open.yml.jinja2 | kubectl delete -f -
```
```bash
# start
python render_template.py vdtr-frag-open.yml.jinja2 | kubectl apply -f -
# stop
python render_template.py vdtr-frag-open.yml.jinja2 | kubectl delete -f -
```

TODO: guidance to setting up PVC?

## Downloads
TODO: link to the video clips for the evaluation
Loading

0 comments on commit 34636fc

Please sign in to comment.