# AGENTS.md

A toolkit for developing and comparing reinforcement learning algorithms.

## Setup

```
pip install -r requirements.txt
```

## Commands

```
pytest   # run the test suite
```

## Layout

- `gym/`   113 source files
- `tests/` 73 source files

## Conventions

- Tests live alongside the code they cover, following `tests/__init__.py`.
- CI defines what passing means. See `.github/workflows/build.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.