# AGENTS.md

Real-ESRGAN aims at developing Practical Algorithms for General Image/Video Restoration.

## Setup

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

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `realesrgan/` 12 source files
- `scripts/`    5 source files
- `tests/`      4 source files

## Conventions

- Tests live alongside the code they cover, following `tests/data/gt.lmdb/data.mdb`.
- CI defines what passing means. See `.github/workflows/publish-pip.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.