# AGENTS.md

Source code for the X Recommendation Algorithm

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

- `src/`                            1256 source files
- `product-mixer/`                  1147 source files
- `home-mixer/`                     743 source files
- `tweetypie/`                      507 source files
- `follow-recommendations-service/` 406 source files
- `tweet-mixer/`                    328 source files

## Conventions

- Tests live alongside the code they cover, following `unified_user_actions/adapter/src/test/scala/com/twitter/unified_user_actions/adapter/AdapterUtilsSpec.scala`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `ann/src/main/java/com/twitter/ann/faiss/swig/swigfaissJNI.java` is 226KB. 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.