Delete README.md
#3
by Pq234 - opened
README.md
DELETED
|
@@ -1,98 +0,0 @@
|
|
| 1 |
-
# RamanBench Dataset Mirror
|
| 2 |
-
|
| 3 |
-
⚠️ **RESEARCH MIRROR ONLY** — All datasets are provided for research/educational purposes. **Original copyrights remain with original authors.** See [Sources & Licenses](#sources--licenses) below.
|
| 4 |
-
|
| 5 |
-
---
|
| 6 |
-
|
| 7 |
-
A unified mirror of 87 Raman spectroscopy datasets from the [RamanBench](https://github.com/ml-lab-htw/RamanBench) benchmark. Wide-format Parquet files for fast, reliable access.
|
| 8 |
-
|
| 9 |
-
## Quick Start
|
| 10 |
-
|
| 11 |
-
```python
|
| 12 |
-
from raman_bench import RamanBenchmark
|
| 13 |
-
|
| 14 |
-
# Fast mirror access (default)
|
| 15 |
-
bench = RamanBenchmark(
|
| 16 |
-
dataset_names_classification=["wheat_lines"],
|
| 17 |
-
dataset_names_regression=["amino_acids_glycine"],
|
| 18 |
-
use_mirror=True # Uses this HF mirror
|
| 19 |
-
)
|
| 20 |
-
```
|
| 21 |
-
|
| 22 |
-
Or load directly:
|
| 23 |
-
```python
|
| 24 |
-
from datasets import load_dataset
|
| 25 |
-
ds = load_dataset("HTW-KI-Werkstatt/RamanBench", "wheat_lines", split="train")
|
| 26 |
-
df = ds.to_pandas()
|
| 27 |
-
```
|
| 28 |
-
|
| 29 |
-
## Citation & Attribution
|
| 30 |
-
|
| 31 |
-
**If using this mirror, cite RamanBench:**
|
| 32 |
-
```bibtex
|
| 33 |
-
@article{koddenbrock2026ramanbench,
|
| 34 |
-
title={RamanBench: A Large-Scale Benchmark for Machine Learning on Raman Spectroscopy},
|
| 35 |
-
author={Koddenbrock, Mario and Lange, Christoph and Legner, Robin and J{\"a}ger, Martin and K{\"o}gler, Martin and Bournazou, Mariano N Cruz and Neubauer, Peter and Biessmann, Felix and Rodner, Erik},
|
| 36 |
-
journal={arXiv preprint arXiv:2605.02003},
|
| 37 |
-
year={2026}
|
| 38 |
-
}
|
| 39 |
-
```
|
| 40 |
-
|
| 41 |
-
**CRITICAL:** You MUST ALSO cite the original dataset sources. Failure to do so violates IP rights.
|
| 42 |
-
|
| 43 |
-
## Dataset Structure
|
| 44 |
-
|
| 45 |
-
- **Parquet files**: Wide-format spectral data
|
| 46 |
-
- Columns: wavenumber floats (e.g., `"200.5"`) + targets (single or multi-target)
|
| 47 |
-
- Data types: `float32` for spectra, `float64`/`string` for targets
|
| 48 |
-
- **Metadata**: `metadata.json` with target names and task type
|
| 49 |
-
|
| 50 |
-
## Available Datasets
|
| 51 |
-
|
| 52 |
-
**87 datasets**: 21 classification + 66 regression
|
| 53 |
-
|
| 54 |
-
Classification: `wheat_lines`, `bacteria_identification`, `cancer_cell_*`, `hair_dyes_sers`, ...
|
| 55 |
-
|
| 56 |
-
Regression: `amino_acids_*`, `bioprocess_analytes_*`, `ecoli_fermentation`, ...
|
| 57 |
-
|
| 58 |
-
See [RamanBench paper](https://arxiv.org/abs/2605.02003) for full list.
|
| 59 |
-
|
| 60 |
-
## Sources & Licenses
|
| 61 |
-
|
| 62 |
-
| Source | License | Copyright Holder |
|
| 63 |
-
|--------|---------|------------------|
|
| 64 |
-
| **Kaggle** | Dataset Terms | Authors/Kaggle |
|
| 65 |
-
| **Zenodo** | CC-BY, CC-0, custom | Depositors |
|
| 66 |
-
| **Figshare** | CC-BY | Depositors |
|
| 67 |
-
| **GitHub (HTW-KI-Werkstatt)** | CC-BY or dataset-specific | Contributors |
|
| 68 |
-
| **HuggingFace Hub** | Varies | Contributors |
|
| 69 |
-
| **RWTH Aachen / Custom** | Institution-dependent | Research groups |
|
| 70 |
-
|
| 71 |
-
**Before using:** Check original source for current license and terms.
|
| 72 |
-
|
| 73 |
-
## Legal Notice
|
| 74 |
-
|
| 75 |
-
**USAGE RIGHTS:**
|
| 76 |
-
- ✅ Research and non-commercial use
|
| 77 |
-
- ✅ Must cite original authors AND RamanBench
|
| 78 |
-
- ✅ Must respect original dataset licenses
|
| 79 |
-
- ❌ No redistribution without original author permission
|
| 80 |
-
- ❌ No commercial use unless licenses permit
|
| 81 |
-
|
| 82 |
-
**INTELLECTUAL PROPERTY:**
|
| 83 |
-
- Original authors/institutions retain all copyrights
|
| 84 |
-
- This mirror is for research convenience only
|
| 85 |
-
- You do NOT own or control these datasets
|
| 86 |
-
|
| 87 |
-
**LIABILITY:** By using this mirror, you acknowledge responsibility for respecting IP rights and following original dataset licenses.
|
| 88 |
-
|
| 89 |
-
## Resources
|
| 90 |
-
|
| 91 |
-
- **RamanBench GitHub**: https://github.com/ml-lab-htw/RamanBench
|
| 92 |
-
- **raman_data Package**: https://github.com/ml-lab-htw/raman_data
|
| 93 |
-
- **Paper**: https://arxiv.org/abs/2605.02003
|
| 94 |
-
- **Leaderboard**: https://huggingface.co/spaces/HTW-KI-Werkstatt/RamanBench
|
| 95 |
-
|
| 96 |
-
---
|
| 97 |
-
|
| 98 |
-
**Last updated**: 2026-06-01 | **License**: CC-BY-4.0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|