From 51c9a2df444d5480d7d756ab222624ae878e2279 Mon Sep 17 00:00:00 2001 From: wassname <1103714+wassname@users.noreply.github.com> Date: Fri, 6 Mar 2026 10:16:24 +0800 Subject: [PATCH] docs: add README with author credit and usage --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1f21c19 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# ML Debugging Folklore + +Deep research to uplift LLMs for ML debugging. Opinionated by source selection. + +Distilled from Schulman's "Nuts and Bolts" talk, Andy Jones' debugging guide, Goodfellow Ch11, CS231n, FSDL, and more. Every non-obvious claim is traced to a verbatim source quote in [`docs/ml_debug_folklore.argdown`](docs/ml_debug_folklore.argdown) (vargdown format). + +**Author**: [wassname](https://github.com/wassname) + +## What's here + +- **[SKILL.md](SKILL.md)** -- the main artifact. Designed to be loaded into an LLM agent's context as a debugging skill. Parts 1-5 are reference knowledge; Part 6 is a runnable triage protocol (grep patterns, diagnostic code snippets, decision tree); Part 7 is debugging mental models and practitioner priors. + +- **[docs/ml_debug_folklore.argdown](docs/ml_debug_folklore.argdown)** -- vargdown source map. Traces each claim to an exact quote + file in `docs/evidence/`. + +- **[docs/evidence/](docs/evidence/)** -- frozen local copies of source material (blog posts, talks, papers, reddit threads). + +## Use as a Claude skill + +``` +/skills add https://github.com/wassname/ml_debug +``` + +Or paste `SKILL.md` into your system prompt / context when debugging. + +## Sources + +Schulman (2017), Jones (2021), Rahtz (2018), Goodfellow et al. (Deep Learning book), Karpathy (CS231n), Ng (CS229), FSDL, Henderson et al. (2018), McCandlish et al. (2018), Irpan (2018), Slavv (2017), and Reddit.