# AGENTS.md

Caffe: a fast open framework for deep learning.

## Setup

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

## Commands

```
make lib
make everything
make linecount
make lint         # lint
make lintclean
make docs
```

## Layout

- `src/`      175 source files
- `include/`  108 source files
- `examples/` 32 source files
- `matlab/`   23 source files
- `python/`   23 source files
- `scripts/`  18 source files

## Conventions

- Tests live alongside the code they cover, following `examples/cifar10/cifar10_full_sigmoid_train_test.prototxt`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/gtest/gtest.h` is 783KB. 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.