Skip to content

Commit

Permalink
Update README to mention categories of environments (#34)
Browse files Browse the repository at this point in the history
* Update README

* Bump from alpha to beta now we have some actual environments and more stable API
  • Loading branch information
AdamGleave authored Jul 7, 2020
1 parent 08b717b commit 444a2c0
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,22 @@

<img src="docs/_static/img/logo.svg" width="50%"/>

**Status**: alpha, pre-release.
**Status**: early beta.

*seals*, the Suite of Environments for Algorithms that Learn Specifications, is a toolkit for
evaluating specification learning algorithms, such as reward or imitation learning. The
environments are compatible with [Gym](https://github.com/openai/gym), but are designed
to test algorithms that learn from user data, without requiring a procedurally specified
reward function.

This is currently a work-in progress. While you are welcome to use the repository, we may make
breaking changes at any time without prior notice. We intend for it to eventually contain:
There are two types of environments in *seals*:

- A suite of diagnostic tasks for reward learning.
- Wrappers around common RL benchmark environments that help to avoid common pitfalls in
benchmarking (e.g. by masking visible score counters in Gym Atari tasks).
- New challenge tasks for specification learning algorithms.
- **Diagnostic Tasks** which test individual facets of algorithm performance in isolation.
- **Renovated Environments**, adaptations of widely-used benchmarks such as MuJoCo continuous
control tasks to be suitable for specification learning benchmarks. In particular, we remove
any side-channel sources of reward information.

*seals* is under active development and we intend to add more categories of tasks soon.

You may also be interested in our sister project [imitation](https://github.com/humancompatibleai/imitation/),
providing implementations of a variety of imitation and reward learning algorithms.
Expand Down

0 comments on commit 444a2c0

Please sign in to comment.