Upload README.md with huggingface_hub

README.md

@@ -31,4 +31,44 @@ configs:
     path: data/train-*
   - split: test
     path: data/test-*
+task_categories:
+- image-classification
+license: cc-by-4.0
+tags:
+- bearing-fault-diagnosis
+- vibration
+- signal-to-image
+- cwru
+- compute-then-check
+pretty_name: CWRU Bearing Fault — Envelope Spectrum (signal→VLM, Category C)
 ---
+# CWRU — bearing fault classification from the envelope spectrum (reasoning track)
+
+Part of the AI4Manufacturing FORGE corpus (Category **C**, task **T-C1**). Each record is the **envelope spectrum** of a 1 s rolling-element-bearing vibration window with the fault frequencies marked — the representation that supports faithful **compute-then-check** chain-of-thought. `reasoning` is empty here; the **`CWRU-annotated`** sibling fills it.
+
+**Records:** 981 (splits {'train': 721, 'test': 260}); labels {'inner_race': 218, 'ball': 215, 'outer_race': 513, 'normal': 35}; evidence_tier {'confirmed': 639, 'weak': 217, 'absent': 125}.
+
+## Schema (7-field unified record)
+| field | meaning |
+|---|---|
+| `query` | the classification instruction (representation-aware) |
+| `image` | the rendered signal image (bytes embedded) |
+| `annot` | gold fault class: normal / inner_race / outer_race / ball |
+| `reasoning` | chain-of-thought (empty here; filled in the `-annotated` sibling) |
+| `cate` / `task` | `C` / `T-C1` (signal fault classification) |
+| `metadata` | JSON: representation, features, fault_freqs, evidence_tier, sr_nondiagnosable, anomaly, bearing_group, rpm, fs, file_number, window_idx, image_sha256, split |
+
+## Splits
+`train` / `test`, **bearing-wise** (leakage-safe).
+
+## Provenance & reproducibility
+Generated **deterministically** by `forge_agent/examples/cwru/convert.py` (`c38f68fad7`) → `forge_model/CWRU/convert_cwru.py` (`ccc0f61ce3`); see `provenance.json` for the full record.
+
+Cleaning (all encoded in the pinned code): excluded the NTN 0.028″ files `3001–3008` (wrong bearing geometry) and the corrupt `191`; flagged Smith & Randall (2015) non-diagnosable (`sr_nondiagnosable`) and acquisition-anomaly files; **bearing-wise leakage-safe split** (all loads + both sample rates of a physical bearing stay on one side). A computed `evidence_tier` (confirmed/weak/absent) cross-checks against the Smith & Randall expert grades.
+
+## Caveats
+- **Ball is the hard class** — Smith & Randall (2015) grade most CWRU ball faults non-diagnosable (intermittent load-zone contact + smeared BSF); those records carry the correct label but a low `evidence_tier`. This is a property of the data, not the converter.
+- **Eval**: use the provided bearing-wise split; the within-condition (per-load) split inflates accuracy.
+
+## Source & license
+Source: **Case Western Reserve University Bearing Data Center** (engineering.case.edu/bearingdatacenter), openly available for research. Diagnosability grades and anomaly flags from W. A. Smith & R. B. Randall, *MSSP* 64–65 (2015) 100–131; leakage-safe split per J. Hendriks et al., *MSSP* 169 (2022) 108732.