Update README.md
Browse files
README.md
CHANGED
|
@@ -85,6 +85,47 @@ Each scenario contains:
|
|
| 85 |
- **Index files**: `hf_dataset/{split}_index_{type}.json` — maps sample indices to `(sim_id, time_id)`
|
| 86 |
- **test_mode metadata**: `{in_dist,out_dist,remain}_params_{type}.json`
|
| 87 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 88 |
**Repository layout**:
|
| 89 |
|
| 90 |
```
|
|
@@ -242,7 +283,7 @@ If you find our work and/or our code useful, please cite us via:
|
|
| 242 |
|
| 243 |
```bibtex
|
| 244 |
@inproceedings{hu2026realpdebench,
|
| 245 |
-
title={RealPDEBench: A Benchmark for Complex Physical Systems with Real-World Data},
|
| 246 |
author={Peiyan Hu and Haodong Feng and Hongyuan Liu and Tongtong Yan and Wenhao Deng and Tianrun Gao and Rong Zheng and Haoren Zheng and Chenglei Yu and Chuanrui Wang and Kaiwen Li and Zhi-Ming Ma and Dezhi Zhou and Xingcai Lu and Dixia Fan and Tailin Wu},
|
| 247 |
booktitle={The Fourteenth International Conference on Learning Representations},
|
| 248 |
year={2026},
|
|
@@ -253,6 +294,6 @@ If you find our work and/or our code useful, please cite us via:
|
|
| 253 |
|
| 254 |
## Contact
|
| 255 |
|
| 256 |
-
AI for Scientific Simulation and Discovery Lab, Westlake University
|
| 257 |
-
Maintainer: `westlake-ai4s` (Hugging Face)
|
| 258 |
Org: `AI4Science-WestlakeU`
|
|
|
|
| 85 |
- **Index files**: `hf_dataset/{split}_index_{type}.json` — maps sample indices to `(sim_id, time_id)`
|
| 86 |
- **test_mode metadata**: `{in_dist,out_dist,remain}_params_{type}.json`
|
| 87 |
|
| 88 |
+
### Arrow shard files vs. trajectory counts
|
| 89 |
+
|
| 90 |
+
> **Important clarification**: The number of `.arrow` shard files does **not** equal the number of trajectories. HuggingFace Arrow format packs multiple rows into one shard up to a size limit (~500 MB by default), but never splits a single row across shards. Real trajectories are smaller (fewer channels, ~130–260 MB each), so 2–4 trajectories are packed per shard, resulting in fewer shards than trajectories. Numerical trajectories are larger (extra channels such as pressure or 15 simulated fields, ~1.5–2.1 GB each), so each one already exceeds the shard limit on its own, resulting in a 1:1 mapping between shards and trajectories.
|
| 91 |
+
|
| 92 |
+
Dataset version: **`2.0.0`** (see `version.json` at repo root; released 2026-01-24, format `lazy_slicing_v2`).
|
| 93 |
+
|
| 94 |
+
| Scenario | Trajectories (real / numerical) | Arrow shards (real / numerical) |
|
| 95 |
+
|---|---:|---:|
|
| 96 |
+
| cylinder | 92 / 92 | 73 / 92 |
|
| 97 |
+
| controlled_cylinder | 96 / 96 | 51 / 96 |
|
| 98 |
+
| fsi | 51 / 51 | 51 / 51 |
|
| 99 |
+
| foil | 98 / 99 | 98 / 99 |
|
| 100 |
+
| combustion | 30 / 30 | 8 / 30 |
|
| 101 |
+
|
| 102 |
+
**Notes:**
|
| 103 |
+
- The **Trajectories** column is the ground-truth count (each row in the Arrow dataset = one complete trajectory). The **Arrow shards** column is the number of `.arrow` files on disk — a storage-level detail that depends on per-trajectory size.
|
| 104 |
+
- The `{remain,in_dist_test,out_dist_test}_params_{real,numerical}.json` files partition trajectories by **physical parameter regime**. Each entry is keyed by HDF5 filename and maps to its parameter tuple (e.g., `(Re, control_freq)`). The three groups sum to the total trajectory count:
|
| 105 |
+
- `in_dist_test_params`: trajectories with in-distribution parameters, **entirely** reserved for testing.
|
| 106 |
+
- `out_dist_test_params`: trajectories with out-of-distribution (edge/extreme) parameters, **entirely** reserved for testing.
|
| 107 |
+
- `remain_params`: all other trajectories — **part** of each trajectory's time axis is used for training, the rest for validation/testing.
|
| 108 |
+
|
| 109 |
+
At evaluation time, `test_mode` can be set to `"seen"` (remain), `"in_dist"`, `"out_dist"`, `"unseen"` (in\_dist + out\_dist), or `"all"`.
|
| 110 |
+
|
| 111 |
+
<details>
|
| 112 |
+
<summary>Per-scenario split counts</summary>
|
| 113 |
+
|
| 114 |
+
| Scenario | Type | remain | in\_dist\_test | out\_dist\_test | Total |
|
| 115 |
+
|---|---|---:|---:|---:|---:|
|
| 116 |
+
| cylinder | real | 72 | 10 | 10 | 92 |
|
| 117 |
+
| cylinder | numerical | 92 | 0 | 0 | 92 |
|
| 118 |
+
| controlled\_cylinder | real | 76 | 10 | 10 | 96 |
|
| 119 |
+
| controlled\_cylinder | numerical | 96 | 0 | 0 | 96 |
|
| 120 |
+
| fsi | real | 39 | 0 | 12 | 51 |
|
| 121 |
+
| fsi | numerical | 51 | 0 | 0 | 51 |
|
| 122 |
+
| foil | real | 78 | 10 | 10 | 98 |
|
| 123 |
+
| foil | numerical | 99 | 0 | 0 | 99 |
|
| 124 |
+
| combustion | real | 30 | 0 | 0 | 30 |
|
| 125 |
+
| combustion | numerical | 30 | 0 | 0 | 30 |
|
| 126 |
+
|
| 127 |
+
</details>
|
| 128 |
+
|
| 129 |
**Repository layout**:
|
| 130 |
|
| 131 |
```
|
|
|
|
| 283 |
|
| 284 |
```bibtex
|
| 285 |
@inproceedings{hu2026realpdebench,
|
| 286 |
+
title={RealPDEBench: A Benchmark for Complex Physical Systems with Real-World Data},
|
| 287 |
author={Peiyan Hu and Haodong Feng and Hongyuan Liu and Tongtong Yan and Wenhao Deng and Tianrun Gao and Rong Zheng and Haoren Zheng and Chenglei Yu and Chuanrui Wang and Kaiwen Li and Zhi-Ming Ma and Dezhi Zhou and Xingcai Lu and Dixia Fan and Tailin Wu},
|
| 288 |
booktitle={The Fourteenth International Conference on Learning Representations},
|
| 289 |
year={2026},
|
|
|
|
| 294 |
|
| 295 |
## Contact
|
| 296 |
|
| 297 |
+
AI for Scientific Simulation and Discovery Lab, Westlake University
|
| 298 |
+
Maintainer: `westlake-ai4s` (Hugging Face)
|
| 299 |
Org: `AI4Science-WestlakeU`
|