# AGENTS.md

Detectron2 is a platform for object detection, segmentation and other visual recognition tasks.

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## 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

- `projects/`   223 source files
- `detectron2/` 167 source files
- `tests/`      65 source files
- `configs/`    38 source files
- `tools/`      12 source files
- `dev/`        9 source files

## Conventions

- Tests live alongside the code they cover, following `configs/quick_schedules/cascade_mask_rcnn_R_50_FPN_inference_acc_test.yaml`.
- CI defines what passing means. See `.github/workflows/check-template.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `detectron2/data/datasets/lvis_v0_5_categories.py` is 219KB. 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.