Skip to content

Commit a78d714

Browse files
Case studies: remove all em dashes, fix anchors, tighten headings
- Convert ~360 em dashes to commas/colons across all five case-study READMEs - Collapse now-stale '--' in intra-doc anchor links so in-page TOC stays intact - Part/Page/subtitle headings use ':' instead of ','; upgrade key comma-splices in the business sections to colons - Verified: 0 em dashes, 0 broken anchors, balanced code fences, 0 'buyer'
1 parent 30d4447 commit a78d714

5 files changed

Lines changed: 396 additions & 413 deletions

File tree

‎case-studies/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ Three real-world stories that show P2Predict on data anyone can download and ver
44

55
| Case study | Audience | Data source | Demonstrates |
66
|---|---|---|---|
7-
| [Battery Management ICs](battery-management-ics/) | EE procurement engineers, electronics category managers, hardware BOM owners | Octopart / Mouser / DigiKey API | The classic parametric procurement use case — `--explain` and `--whatif` for spec-driven cost trade-offs |
8-
| [Used vehicles](used-cars/) | Anyone — the universally-relatable tutorial | Kaggle (CC license) | Log-target SHAP + multiplicative explanations on prices that span orders of magnitude |
9-
| [Aerospace fasteners](aerospace-fasteners/) | Fastener / MRO category managers, federal procurement, cost engineers | DLA PUB LOG / FLIS catalog (public domain) | **Detecting noisy data** — measuring a model's R² ceiling before tuning, plus log-target multiplicative SHAP on a heavily-skewed price |
7+
| [Battery Management ICs](battery-management-ics/) | EE procurement engineers, electronics category managers, hardware BOM owners | Octopart / Mouser / DigiKey API | The classic parametric procurement use case, `--explain` and `--whatif` for spec-driven cost trade-offs |
8+
| [Used vehicles](used-cars/) | Anyone, the universally-relatable tutorial | Kaggle (CC license) | Log-target SHAP + multiplicative explanations on prices that span orders of magnitude |
9+
| [Aerospace fasteners](aerospace-fasteners/) | Fastener / MRO category managers, federal procurement, cost engineers | DLA PUB LOG / FLIS catalog (public domain) | **Detecting noisy data**, measuring a model's R² ceiling before tuning, plus log-target multiplicative SHAP on a heavily-skewed price |
1010

1111
## Why these, in this order
1212

1313
- **Battery Management ICs** is the closest-to-target audience. Procurement engineers in EE will recognise the methodology immediately and pay attention.
1414
- **Used vehicles** is the warm-up tutorial. Everyone gets the problem, the data is clean, and it's the strongest visual demo of P2Predict's log-target multiplicative SHAP attribution.
15-
- **Aerospace fasteners** is the *honesty* story. It's the one case study where the model is deliberately weak — and the value is the diagnostic that proves it's the data, not the model. It teaches how to measure a noise floor and know when to stop tuning, the skill that matters most on messy real-world data. The dataset (DLA PUB LOG, public domain) is also a credibility signal to the federal-procurement and cost-estimating audience.
15+
- **Aerospace fasteners** is the *honesty* story. It's the one case study where the model is deliberately weak, and the value is the diagnostic that proves it's the data, not the model. It teaches how to measure a noise floor and know when to stop tuning, the skill that matters most on messy real-world data. The dataset (DLA PUB LOG, public domain) is also a credibility signal to the federal-procurement and cost-estimating audience.
1616

1717
The three different doors into the same product matter: an EE engineer finds #1, a curious developer finds #2, a fastener category manager finds #3. None overlap.
1818

@@ -23,14 +23,14 @@ Each subfolder has the same four files:
2323
```
2424
case-studies/<name>/
2525
README.md ← the procurement story, results, takeaways (5-minute read)
26-
fetch_data.py ← pulls data from the source — credentials in env vars
26+
fetch_data.py ← pulls data from the source, credentials in env vars
2727
train.py ← trains a P2Predict model (or just documents the CLI command)
2828
predict_examples.py ← runs sample predictions with --explain and --interval
2929
```
3030

3131
The pattern is deliberate: anyone reading the case study's `README.md` should be able to reproduce the result end-to-end in under 15 minutes if they have the right API credentials (for #1) or just an internet connection (for the public-data studies).
3232

33-
## Reproducibility — what's checked in and what isn't
33+
## Reproducibility, what's checked in and what isn't
3434

3535
| Type | Checked in? | Why |
3636
|---|---|---|

0 commit comments

Comments
 (0)