# AGENTS.md

🧑‍🏫 60+ Implementations/tutorials of deep learning papers with side-by-side notes 📝; including transformers (original, xl, switch, feedback, vit, ...), optimizers (adam, adabelief, sophia, ...), gans(cyclegan, stylegan2, ...), 🎮 reinforcement learning (ppo, dqn), capsnet, distillation, ... 🧠

## Setup

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

## Commands

```
make clean
make build           # produce a build
make check-content
make check           # lint and type check
make upload
make install
```

## Layout

- `labml_nn/` 222 source files
- `docs/`     4 source files
- `utils/`    4 source files

## Conventions

- Tests live alongside the code they cover, following `docs/ja/optimizers/performance_test.html`.
- 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.