Skip to content

Commit

Permalink
Edits to the README.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 351134975
  • Loading branch information
Rico Jonschkowski authored and copybara-github committed Jan 11, 2021
1 parent aaac197 commit 0f6d747
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions distracting_control/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# `distracting_control_suite`: A visual distraction suite for `dm_control`
# The Distracting Control Suite

`distracting_control` extends `dm_control` with static or dynamic visual
distractions in the form of changing colors, backgrounds, and camera poses.
Details and experimental results can be found in our
[paper](https://arxiv.org/pdf/2101.02722.pdf).

## Requirements and Installation

Expand All @@ -11,27 +16,31 @@

## Instructions

* You can run the `distracting_control_demo` to generate sample images of thet
* You can run the `distracting_control_demo` to generate sample images of the
different tasks at different difficulties:

```
python distracting_control_demo --davis_path=$HOME/DAVIS/JPEGImages/480p/
--output_dir=/tmp/distrtacting_control_demo
```
* As seen from the demo to generate an instance of the environment you simply
need to import the suitet and use `suite.load` while specifying the
need to import the suite and use `suite.load` while specifying the
`dm_control` domain and task, then choosing a difficulty and providing the
dataset_path.

* Note the environment follows the dm_control environment APIs.

## Paper

TODO: link to arxiv paper

If you use this code, please cite it as:
If you use this code, please cite the accompanying [paper](https://arxiv.org/pdf/2101.02722.pdf) as:

```
@article{stone2021distracting,
title={The Distracting Control Suite -- A Challenging Benchmark for Reinforcement Learning from Pixels},
author={Austin Stone and Oscar Ramirez and Kurt Konolige and Rico Jonschkowski},
year={2021},
journal={arXiv preprint arXiv:2101.02722},
}
```

## Disclaimer
Expand Down

0 comments on commit 0f6d747

Please sign in to comment.