agentreadme

Report · marked 25 Aug 2026

microsoft/ML-For-Beginners

Solid foundations, held back in a few specific places.

Jupyter Notebook · 89,798 stars · 17,223 files · branch main

Fix these first

01
Test command is discoverable
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
02
Repository weight
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.
03
Lint and format rules
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.

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.
Instruction quality 12/12
Specific enough that an agent can act on it.
10,685 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 14/16 A

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

Deterministic install 6/6
package-lock.json pins the dependency tree.
Found package-lock.json
Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (convert)
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 2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 10/25 C

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

Tests exist 6/8
2 test files against 27 source files.
e.g. 7-TimeSeries/2-ARIMA/images/train-test.png, 7-TimeSeries/3-SVR/images/train-test.png
Test command is discoverable 0/7
There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
Continuous integration 4/4
3 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 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 15/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 198 patterns.
File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
Repository weight 0/5
About 2234MB 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 — drafted for microsoft/ML-For-Beginners
# AGENTS.md

12 weeks, 26 lessons, 52 quizzes, classic Machine Learning for all

## Setup

```
npm ci
```

## Commands

```
npm run convert
```

## Layout

- `7-TimeSeries/`    13 source files
- `quiz-app/`        8 source files
- `6-NLP/`           2 source files
- `8-Reinforcement/` 2 source files
- `3-Web-App/`       1 source file

## Conventions

- Tests live alongside the code they cover, following `7-TimeSeries/2-ARIMA/images/train-test.png`.
- CI defines what passing means. See `.github/workflows/generator-generic-ossf-slsa3-publish.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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/microsoft/ML-For-Beginners.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 76 out of 100

[![agent ready](https://agentreadme.com/badge/microsoft/ML-For-Beginners.svg)](https://agentreadme.com/microsoft/ML-For-Beginners)

Other Jupyter Notebook repositories, marked

jackfrued/Python-100-Days 22 F microsoft/generative-ai-for-beginners 88 A rasbt/LLMs-from-scratch 54 C+ openai/openai-cookbook 68 B CompVis/stable-diffusion 32 D microsoft/ai-agents-for-beginners 66 B

All Jupyter Notebook 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