# AGENTS.md

A high-throughput and memory-efficient inference and serving engine for LLMs

## Setup

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

## Commands

```
pytest         # run the test suite
ruff check .   # lint
```

## Layout

- `vllm/`       2234 source files
- `tests/`      1762 source files
- `rust/`       310 source files
- `examples/`   166 source files
- `csrc/`       135 source files
- `benchmarks/` 108 source files

## Conventions

- Tests live alongside the code they cover, following `.buildkite/amd-disagg/run-slurm-disagg-test.sh`.
- CI defines what passing means. See `.github/workflows/add_label_automerge.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `vllm/entrypoints/serve/instrumentator/static/swagger-ui-bundle.js` is 1475KB. 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.