Upload README.md with huggingface_hub

README.md

@@ -1,163 +1,73 @@
----
-license: mit
-configs:
-- config_name: bearings
-  data_files:
-  - split: train
-    path: bearings/train-*
-- config_name: gearboxes
-  data_files:
-  - split: train
-    path: gearboxes/train-*
-- config_name: source_metadata
-  data_files:
-  - split: train
-    path: source_metadata/train-*
-dataset_info:
-- config_name: bearings
-  features:
-  - name: signal
-    list:
-      list: float32
-  - name: n_channels
-    dtype: int32
-  - name: sampling_rate_hz
-    dtype: int32
-  - name: dataset_source
-    dtype: string
-  - name: sample_id
-    dtype: string
-  - name: health_state
-    dtype: string
-  - name: channel_names
-    list: string
-  - name: fault_type
-    dtype: string
-  - name: fault_severity
-    dtype: string
-  - name: rpm
-    dtype: int32
-  - name: load
-    dtype: int32
-  - name: load_unit
-    dtype: string
-  - name: component_type
-    dtype: string
-  - name: manufacturer
-    dtype: string
-  - name: model
-    dtype: string
-  - name: original_file
-    dtype: string
-  - name: license
-    dtype: string
-  - name: split
-    dtype: string
-  - name: extra_metadata
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 1294579773
-    num_examples: 3849
-  download_size: 1293644219
-  dataset_size: 1294579773
-- config_name: gearboxes
-  features:
-  - name: source_id
-    dtype: string
-  - name: sample_id
-    dtype: string
-  - name: original_file
-    dtype: string
-  - name: signal
-    list:
-      list: float64
-  - name: n_channels
-    dtype: int64
-  - name: channel_names
-    list: string
-  - name: channel_modalities
-    list: string
-  - name: slow_signals
-    dtype: 'null'
-  - name: health_state
-    dtype: string
-  - name: fault_type
-    dtype: string
-  - name: fault_severity
-    dtype: 'null'
-  - name: rpm
-    dtype: int64
-  - name: load
-    dtype: float64
-  - name: load_unit
-    dtype: string
-  - name: episode_id
-    dtype: 'null'
-  - name: episode_position
-    dtype: 'null'
-  - name: cumulative_runtime_hours
-    dtype: 'null'
-  - name: rul_percent
-    dtype: 'null'
-  - name: is_transition
-    dtype: bool
-  - name: transition_type
-    dtype: 'null'
-  - name: split
-    dtype: string
-  - name: extra_metadata
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 1882166716
-    num_examples: 1085
-  download_size: 1882002968
-  dataset_size: 1882166716
-- config_name: source_metadata
-  features:
-  - name: source_id
-    dtype: string
-  - name: full_name
-    dtype: string
-  - name: url
-    dtype: string
-  - name: license
-    dtype: string
-  - name: citation
-    dtype: string
-  - name: sampling_rate_hz
-    dtype: int64
-  - name: signal_duration_sec
-    dtype: float64
-  - name: available_modalities
-    list: string
-  - name: modality_details
-    dtype: string
-  - name: component_type
-    dtype: string
-  - name: component_subtype
-    dtype: string
-  - name: component_context
-    dtype: string
-  - name: manufacturer
-    dtype: string
-  - name: model
-    dtype: string
-  - name: has_episodes
-    dtype: bool
-  - name: has_transitions
-    dtype: bool
-  - name: has_continuous_severity
-    dtype: bool
-  - name: available_fault_types
-    list: string
-  - name: n_samples
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 4766
-    num_examples: 10
-  download_size: 12913
-  dataset_size: 4766
----
+---
+license: mit
+configs:
+- config_name: source_metadata
+  data_files:
+  - split: train
+    path: source_metadata/train-*
+- config_name: bearings
+  data_files:
+  - split: train
+    path: bearings/train-*
+- config_name: gearboxes
+  data_files:
+  - split: train
+    path: gearboxes/train-*
+---
+
+# Mechanical Components Vibration Dataset
+
+A comprehensive, multi-source mechanical vibration dataset for training and evaluating machine learning models for fault diagnosis and prognostics.
+
+## Two-Level Schema
+
+### 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
+
+| 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 |
+| OEDI | gearboxes | 20 | No | No |
+| PHM 2009 | gearboxes | 109 | No | No |
+| MCC5-THU | gearboxes | 956 | Yes | Yes |
+
+## 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