Upload README.md with huggingface_hub

README.md

@@ -4,70 +4,49 @@ configs:
 - config_name: source_metadata
   data_files:
   - split: train
-    path: source_metadata/train-*
+    path: source_metadata/*.parquet
 - config_name: bearings
   data_files:
   - split: train
-    path: bearings/train-*
+    path: bearings/*.parquet
 - config_name: gearboxes
   data_files:
   - split: train
-    path: gearboxes/train-*
+    path: gearboxes/*.parquet
 ---
 
 # Mechanical Components Vibration Dataset
 
-A comprehensive, multi-source mechanical vibration dataset for training and evaluating machine learning models for fault diagnosis and prognostics.
+Comprehensive multi-source mechanical vibration dataset for fault diagnosis and prognostics.
 
 ## Two-Level Schema
+- **source_metadata**: One row per source dataset (10 sources)
+- **bearings**: Per-sample vibration data from 7 bearing sources
+- **gearboxes**: Per-sample vibration data from 3 gearbox sources
 
-### Level 1: source_metadata
-One row per source dataset containing constant properties (sampling rate, component info, etc.)
-
-### Level 2: bearings / gearboxes
-Per-sample data with `source_id` foreign key to source_metadata.
-
-## Dataset Sources
+## Sources
 
 | Source | Config | Samples | Episodes | Transitions |
 |--------|--------|---------|----------|-------------|
 | CWRU | bearings | 40 | No | No |
 | MFPT | bearings | 20 | No | No |
-| FEMTO | bearings | ~3500 | Yes | No |
-| Mendeley | bearings | 280 | Yes | Yes |
-| XJTU-SY | bearings | 1370 | Yes | No |
+| FEMTO | bearings | 3,569 | Yes (RUL) | No |
+| Mendeley | bearings | 280 | Yes | Yes (279) |
+| XJTU-SY | bearings | 1,370 | Yes (RUL) | No |
+| IMS | bearings | 1,256 | Yes (RUL) | No |
+| Paderborn | bearings | 384 | No | No |
 | OEDI | gearboxes | 20 | No | No |
 | PHM 2009 | gearboxes | 109 | No | No |
-| MCC5-THU | gearboxes | 956 | Yes | Yes |
+| MCC5-THU | gearboxes | 956 | Yes | Yes (133) |
+
+**Total: ~8,004 samples across 10 sources**
 
 ## Usage
 
 ```python
 from datasets import load_dataset
 
-# Load bearing samples
 bearings = load_dataset("Forgis/Mechanical-Components", "bearings", split="train")
-
-# Load gearbox samples
 gearboxes = load_dataset("Forgis/Mechanical-Components", "gearboxes", split="train")
-
-# Load source metadata
 sources = load_dataset("Forgis/Mechanical-Components", "source_metadata", split="train")
-sources_dict = {s["source_id"]: s for s in sources}
-
-# Get full info for a sample
-sample = bearings[0]
-source = sources_dict[sample["source_id"]]
 ```
-
-## Citations
-
-Please cite the original datasets when using this data:
-- CWRU: Case Western Reserve University Bearing Data Center
-- MFPT: Society for Machinery Failure Prevention Technology
-- FEMTO: Nectoux et al., IEEE PHM 2012
-- Mendeley: Bearing Fault Dataset Under Varying Speed Conditions
-- XJTU-SY: Wang et al., IEEE Trans. Instrumentation and Measurement, 2020
-- OEDI: U.S. Department of Energy Open Energy Data Initiative
-- PHM 2009: PHM Society 2009 Data Challenge
-- MCC5-THU: Liu et al., Tsinghua University / MCC5 Group Shanghai