# AGENTS.md

🐸💬 - a deep learning toolkit for Text-to-Speech, battle-tested in research and production

## Setup

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

## Commands

```
make help
make target_dirs
make test_all
make test           # run the test suite, must pass before any commit
make test_vocoder
make test_tts
```

## Layout

- `TTS/`       293 source files
- `tests/`     92 source files
- `recipes/`   55 source files
- `docs/`      1 source file
- `notebooks/` 1 source file
- `scripts/`   1 source file

## Conventions

- Tests live alongside the code they cover, following `tests/__init__.py`.
- CI defines what passing means. See `.github/workflows/aux_tests.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.