# AGENTS.md

Composable transformations of Python+NumPy programs: differentiate, vectorize, JIT to GPU/TPU, and more

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

- `jax/`      662 source files
- `tests/`    262 source files
- `jaxlib/`   244 source files
- `ci/`       31 source files
- `docs/`     27 source files
- `examples/` 23 source files

## Conventions

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

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `docs/notebooks/shard_map.py` is 2310KB. 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.