# AGENTS.md

The largest collection of PyTorch image encoders / backbones. Including train, eval, inference, export scripts, and pretrained weights -- ResNet, ResNeXT, EfficientNet, NFNet, Vision Transformer (ViT), MobileNetV4, MobileNet-V3 & V2, RegNet, DPN, CSPNet, Swin Transformer, MaxViT, CoAtNet, ConvNeXt, and more

## Setup

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

## Commands

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

## Layout

- `timm/`    285 source files
- `tests/`   16 source files
- `convert/` 4 source files
- `results/` 1 source file

## Conventions

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

## Gotchas

- `timm/models/vision_transformer.py` is 213KB. It will not fit comfortably in context, so read it in parts.
- 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.