jiangab commited on
Commit
93b42dd
·
verified ·
1 Parent(s): 10d1755

Add a Dataset Card.

Browse files
Files changed (1) hide show
  1. README.md +117 -0
README.md CHANGED
@@ -551,3 +551,120 @@ configs:
551
  - split: fd
552
  path: wtpg/fd-*
553
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
551
  - split: fd
552
  path: wtpg/fd-*
553
  ---
554
+
555
+ <h1 align="center">
556
+ RMIS Benchmark Datasets
557
+ </h1>
558
+
559
+ ## Introduction
560
+
561
+ RMIS is a benchmark dataset collection for evaluating representation learning on **multi-modal industrial signals**. It brings together the datasets used in the RMIS benchmark, covering **anomaly detection** and **fault diagnosis** across four modalities: **sound, vibration, voltage, and current**.
562
+
563
+ This Hugging Face repository is meant to provide the **benchmark datasets themselves** in an easy-to-load format. If you are looking for the full benchmark codebase, evaluation pipeline, or leaderboard, please refer to the [RMIS GitHub repository](https://github.com/jianganbai/RMIS).
564
+
565
+ RMIS is closely related to **FISHER**:
566
+
567
+ - **FISHER** is the foundation model proposed for industrial signal representation.
568
+ - **RMIS** is the benchmark used to evaluate FISHER and other signal models.
569
+ - This Hugging Face repository hosts the **dataset side** of RMIS, while the GitHub repository hosts the **benchmark code and evaluation pipeline**.
570
+
571
+ In the current release, the dataset includes **19 configurations**:
572
+
573
+ - **Anomaly detection**: `dcase20`, `dcase21`, `dcase22`, `dcase23`, `dcase24`, `dcase25`
574
+ - **Fault diagnosis**: `iica`, `iiee`, `mafaulda_sound`, `mafaulda_vib`, `pu_cur`, `pu_vib`, `sdust_bearing`, `sdust_gear`, `umged_cur`, `umged_sound`, `umged_vib`, `umged_vol`, `wtpg`
575
+
576
+ ## What is included
577
+
578
+ Each configuration corresponds to one benchmark subset. The exact schema varies by subset, but all configurations provide an `audio` column together with file-level metadata such as `file_name`, and task-specific annotations such as `status`, `scene`, `mt`, `ori`, `domain`, or related attributes.
579
+
580
+ The split names follow the benchmark tasks:
581
+
582
+ - `ad`: anomaly detection subsets
583
+ - `fd`: fault diagnosis subsets
584
+
585
+ Please note that this repository focuses on **dataset hosting and loading**. Detailed benchmark construction, preprocessing rationale, evaluation protocol, and model integration are documented in the RMIS GitHub repository.
586
+
587
+ ## Usage
588
+
589
+ Load one subset with `datasets`:
590
+
591
+ ```python
592
+ from datasets import load_dataset
593
+
594
+ ds = load_dataset("jiangab/RMIS", "dcase20", split="ad")
595
+ print(ds)
596
+ print(ds[0])
597
+ ```
598
+
599
+ If you want decoded waveforms instead of deferred audio objects:
600
+
601
+ ```python
602
+ from datasets import load_dataset, Audio
603
+
604
+ ds = load_dataset("jiangab/RMIS", "dcase20", split="ad")
605
+ ds = ds.cast_column("audio", Audio(sampling_rate=16000))
606
+
607
+ sample = ds[0]
608
+ audio = sample["audio"]["array"]
609
+ sr = sample["audio"]["sampling_rate"]
610
+ print(audio.shape, sr)
611
+ ```
612
+
613
+ Load another configuration in the same way:
614
+
615
+ ```python
616
+ from datasets import load_dataset
617
+
618
+ # fault diagnosis example
619
+ fds = load_dataset("jiangab/RMIS", "umged_vib", split="fd")
620
+ print(fds.column_names)
621
+ ```
622
+
623
+ If you want to download the **entire dataset repository at once** instead of loading one configuration at a time, you can download the whole Hugging Face dataset repo locally:
624
+
625
+ ```python
626
+ from huggingface_hub import snapshot_download
627
+
628
+ local_dir = snapshot_download(
629
+ repo_id="jiangab/RMIS",
630
+ repo_type="dataset",
631
+ )
632
+ print(local_dir)
633
+ ```
634
+
635
+ You can also use the Hugging Face CLI:
636
+
637
+ ```bash
638
+ hf download jiangab/RMIS --repo-type dataset
639
+ ```
640
+
641
+ Please note that `load_dataset` is typically used **one configuration at a time**, while whole-repository download is useful when you want all released subsets stored locally.
642
+
643
+ ## Recommended usage in the RMIS project
644
+
645
+ If your goal is to **benchmark a model on RMIS**, this dataset repository is only one part of the workflow. A typical setup is:
646
+
647
+ 1. Load a subset from this Hugging Face dataset repository.
648
+ 2. Extract signal representations with your model.
649
+ 3. Evaluate the representations with the RMIS benchmark pipeline from the GitHub repository.
650
+
651
+ In other words, this repository provides the **benchmark data**, while the RMIS codebase provides the **standardized evaluation**.
652
+
653
+ ## Acknowledgements
654
+
655
+ RMIS is built from multiple public industrial signal datasets. We thank the original dataset creators for making these resources available.
656
+
657
+ If you believe that any content in this repository infringes your rights, please contact us and we will address the issue promptly.
658
+
659
+ ## Citation
660
+
661
+ If you find RMIS useful, please cite the following paper.
662
+
663
+ ```bibtex
664
+ @article{fan2025fisher,
665
+ title={FISHER: A Foundation Model for Multi-Modal Industrial Signal Comprehensive Representation},
666
+ author={Fan, Pingyi and Jiang, Anbai and Zhang, Shuwei and Lv, Zhiqiang and Han, Bing and Zheng, Xinhu and Liang, Wenrui and Li, Junjie and Zhang, Wei-Qiang and Qian, Yanmin and Chen, Xie and Lu, Cheng and Liu, Jia},
667
+ journal={arXiv preprint arXiv:2507.16696},
668
+ year={2025}
669
+ }
670
+ ```