agentreadme

Report · marked 26 Aug 2026

ultralytics/yolov5

Solid foundations, held back in a few specific places.

Python · 57,923 stars · 144 files · branch master

Fix these first

01
Discoverable commands
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
02
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
03
Static type checking
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.

The full marking

Every deduction below names the file or setting it came from.

Instructions 27/27 A+

Whether the repo tells an agent how to behave before it starts guessing.

Agent instruction file 12/12
AGENTS.md is present, which is the format the most tools read.
Also found: CLAUDE.md
Instruction quality 12/12
Specific enough that an agent can act on it.
7,603 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
README as an entry point 3/3
README has a clear getting-started section.
Setup 3/14 F

Whether an agent can install the project and get it running without a human.

Deterministic install 3/6
Only requirements.txt, which pins loosely at best.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
Discoverable commands 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
Environment config n/a
Not applicable — this reads as a library, with no environment to configure.
Pinned runtime version 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 20/25 A-

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

Tests exist 6/8
3 test files against 59 source files.
e.g. tests/test_flask_rest_api.py, tests/test_invariant_common.py, tests/test_invariant_export.py
Test command is discoverable 7/7
An agent can find and run `pytest`.
Continuous integration 4/4
7 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
pyproject.toml encodes the house style.
Static type checking 0/3
No static type checking.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
Context economy 20/20 A+

Whether the repo fits in a context window, or fights it.

No committed build output 6/6
No generated directories committed.
.gitignore hygiene 3/3
.gitignore covers 153 patterns.
File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
Repository weight 5/5
About 18.1MB checked out, which is comfortable.

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md — drafted for ultralytics/yolov5
# AGENTS.md

Ultralytics YOLOv5 in PyTorch for object detection, instance segmentation, classification, training, and export.

## Setup

```
pip install -r requirements.txt
```

## Commands

```
pytest         # run the test suite
ruff check .   # lint
```

## Layout

- `utils/`    32 source files
- `data/`     7 source files
- `models/`   5 source files
- `classify/` 3 source files
- `segment/`  3 source files
- `tests/`    3 source files

## Conventions

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

## Gotchas

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

Open the raw markdown  or  curl -o AGENTS.md agentreadme.com/draft/ultralytics/yolov5.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 81 out of 100

[![agent ready](https://agentreadme.com/badge/ultralytics/yolov5.svg)](https://agentreadme.com/ultralytics/yolov5)

Other Python repositories, marked

vinta/awesome-python 81 A- NousResearch/hermes-agent 84 A- TheAlgorithms/Python 66 B yt-dlp/yt-dlp 54 C+ Significant-Gravitas/AutoGPT 63 B microsoft/markitdown 46 C

All Python repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in