Report · marked 26 Aug 2026
PaddlePaddle/PaddleOCR
An agent will struggle here, mostly for fixable reasons.
Python · 88,270 stars · 2,492 files · branch main
53
/100
C+
Instructions
3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
9/20Whether an agent can install the project and get it running without a human. Losing marks on deterministic install and environment config.Verification loop
19/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and lint and format rules.Context economy
13/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability
10/10How quickly anything new can orient itself. Full marks.
Higher is better. Accent marks what is costing you most.
Fix these first
01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
Environment config
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
The full marking
Every deduction below names the file or setting it came from.
Instructions 3/27 F
Whether the repo tells an agent how to behave before it starts guessing.
✗Agent instruction file
0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
✗Instruction quality
0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
✓README as an entry point
3/3
README has a clear getting-started section.
Setup 9/20 C
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
6/6
Commands are declared where an agent will look for them.
pyproject.toml scripts
✗Environment config
0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
✗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
0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 19/25 B+
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✗Tests exist
6/8
105 test files against 953 source files.
e.g. api_sdk/go/client_test.go, api_sdk/typescript/tests/client.test.ts, benchmark/PaddleOCR_DBNet/test/README.MD
✓Test command is discoverable
7/7
An agent can find and run `pytest`.
✓Continuous integration
4/4
9 GitHub Actions workflows define what "passing" means.
✗Lint and format rules
0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
✗Static type checking
2/3
Type checking is configured, but not in strict mode.
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 13/20 B
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 30 patterns.
✗File sizes fit in context
4/6
2 source files are over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
deploy/android_demo/app/src/main/cpp/ocr_clipper.cpp — 135KB
deploy/ios_demo/PaddleOCRDemo/ThirdParty/Clipper1/clipper.cpp — 135KB
✗Repository weight
0/5
About 1964MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.
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 Turn any PDF or image document into structured data for your AI. A powerful, lightweight OCR toolkit that bridges the gap between images/PDFs and LLMs. Supports 100+ languages. ## Setup ``` pip install -r requirements.txt ``` ## Commands ``` pytest # run the test suite ``` ## Layout - `deploy/` 262 source files - `ppocr/` 254 source files - `paddleocr-js/` 81 source files - `paddleocr/` 72 source files - `benchmark/` 63 source files - `tests/` 43 source files ## Conventions - Tests live alongside the code they cover, following `api_sdk/go/client_test.go`. - CI defines what passing means. See `.github/workflows/build_publish_develop_docs.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `deploy/android_demo/app/src/main/cpp/ocr_clipper.cpp` 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.
Open the raw markdown
or
curl -o AGENTS.md agentreadme.com/draft/PaddlePaddle/PaddleOCR.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/PaddlePaddle/PaddleOCR)Other Python repositories, marked
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.