From fb2737fc4a6ecf96eb7d8b41f74b8ee58e6e3d86 Mon Sep 17 00:00:00 2001 From: mathias Date: Wed, 27 May 2026 22:00:17 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20add=20notebooks/README.md=20=E2=80=94?= =?UTF-8?q?=20EDA-only=20policy,=20output=20stripping=20rule?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- notebooks/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 notebooks/README.md diff --git a/notebooks/README.md b/notebooks/README.md new file mode 100644 index 0000000..7091ae1 --- /dev/null +++ b/notebooks/README.md @@ -0,0 +1,11 @@ +# Notebooks + +Exploratory Data Analysis (EDA) scratch space only. + +## Rules + +- **Never use notebooks for anything reproducible.** Training, evaluation, and metric computation belong in `src/` with tests. +- **Strip all outputs before committing.** Use `nbstripout` or equivalent. +- **Label every notebook with a phase prefix:** `phase0-eda-eurusd-distribution.ipynb` + +Notebooks are thinking tools, not research artifacts. If a finding from a notebook is worth keeping, it goes into a spec, a decision in `DECISIONS.md`, or a result in `results/summaries/` — not the notebook itself.