Report · marked 25 Aug 2026
deepspeedai/DeepSpeed
Solid foundations, held back in a few specific places.
Python · 42,997 stars · 2,093 files · branch master
77
/100
B+
Instructions
23/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on instruction quality.Setup
6/14Whether an agent can install the project and get it running without a human. Losing marks on deterministic install and pinned runtime version.Verification loop
22/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on static type checking.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
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.
02
Instruction quality
Worth fixing: it never states a build, test, or run command.
03
File sizes fit in context
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.
The full marking
Every deduction below names the file or setting it came from.
Instructions 23/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
8/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command.
2,036 characters, a workable length
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 6/14 C
Whether an agent can install the project and get it running without a human.
✗Deterministic install
0/6
No lockfile. An agent installing dependencies may not get what CI got.
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.
Makefile
scripts/ directory
–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 22/25 A
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✓Tests exist
8/8
365 test files against 1331 source files.
e.g. ci/test_tests_fetcher.py, ci/test_torch_latest.py, csrc/aio/py_test/test_ds_aio.py
✓Test command is discoverable
7/7
An agent can find and run `make test`.
✓Continuous integration
4/4
30 GitHub Actions workflows define what "passing" means.
✓Lint and format rules
3/3
.flake8 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 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
2/6
5 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.
deepspeed/runtime/engine.py — 287KB
deepspeed/runtime/zero/stage3.py — 190KB
deepspeed/runtime/zero/stage_1_and_2.py — 154KB
✗Repository weight
2/5
About 248MB 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 DeepSpeed is a deep learning optimization library that makes distributed training and inference easy, efficient, and effective. ## Setup ``` # TODO: the install command. No lockfile was found, so this could not be inferred. ``` ## Commands ``` make help make test # run the test suite, must pass before any commit make format # format ``` ## Layout - `deepspeed/` 709 source files - `tests/` 327 source files - `csrc/` 165 source files - `op_builder/` 91 source files - `accelerator/` 12 source files - `examples/` 7 source files ## Conventions - Tests live alongside the code they cover, following `ci/test_tests_fetcher.py`. - CI defines what passing means. See `.github/workflows/amd-mi200.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `deepspeed/runtime/engine.py` is 287KB. 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/deepspeedai/DeepSpeed.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/deepspeedai/DeepSpeed)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.