# AGENTS.md

🤗 Transformers: the model-definition framework for state-of-the-art machine learning models in text, vision, audio, and multimodal models, for both inference and training. 

## Setup

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

## Commands

```
make style
make typing
make check-code-quality
make check-repo
make fix-repo
make test                 # run the test suite, must pass before any commit
```

## Layout

- `src/`       2966 source files
- `tests/`     1625 source files
- `examples/`  100 source files
- `utils/`     78 source files
- `docs/`      11 source files
- `benchmark/` 6 source files

## Conventions

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

## Gotchas

- `tests/test_modeling_common.py` is 307KB. 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.