# AGENTS.md

Unified Efficient Fine-Tuning of 100+ LLMs & VLMs (ACL 2024)

## Setup

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

## Commands

```
make check_dirs
make ruff_version
make build          # produce a build
make commit
make license
make quality
```

## Layout

- `src/`      219 source files
- `tests/`    37 source files
- `scripts/`  21 source files
- `tests_v1/` 20 source files
- `docs/`     4 source files
- `examples/` 4 source files

## Conventions

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

## Gotchas

- `src/llamafactory/data/mm_plugin.py` is 135KB. 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.