# AGENTS.md

A library for efficient similarity search and clustering of dense vectors.

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

- `faiss/`    510 source files
- `tests/`    127 source files
- `benchs/`   75 source files
- `c_api/`    70 source files
- `demos/`    28 source files
- `tutorial/` 21 source files

## Conventions

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

## Gotchas

- `tests/test_read_index_deserialize.cpp` is 183KB. 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.