Link the ICLR 2027 release
Browse files
README.md
CHANGED
|
@@ -14,14 +14,30 @@ tags:
|
|
| 14 |
|
| 15 |
# SparseWake
|
| 16 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
SparseWake is an anonymous benchmark artifact for sparse temporal hydrodynamic sensing. It contains processed HDF5 datasets, metadata, summary CSV files, checksums, and lightweight Python scripts for inspecting the data and reproducing benchmark-level evaluation outputs.
|
| 18 |
-
## Dataset Summary
|
| 19 |
|
| 20 |
SparseWake evaluates whether sparse body-fixed temporal flow measurements can recover the relative state of a neighboring wake-producing fish in a controlled single-leader setting. The benchmark data are synthetic and were generated from a DNS-parameterized fish-schooling agent-based model. The artifact starts from processed HDF5 files and does not require the upstream simulator or high-fidelity solver.
|
| 21 |
|
| 22 |
The released data support held-out-pose evaluation, temporal-history sweeps, sensor-count ablations, component-separated flow inputs, common raw-noise stress tests, sample-size convergence checks, architecture screening summaries, and paired self-signal controls.
|
| 23 |
|
| 24 |
-
## What Is Included
|
| 25 |
|
| 26 |
- Full processed HDF5 benchmark datasets in `data/processed/`.
|
| 27 |
- A small sample HDF5 file in `data/sample/` for inspection and smoke tests.
|
|
@@ -33,7 +49,7 @@ The released data support held-out-pose evaluation, temporal-history sweeps, sen
|
|
| 33 |
- Checksums in `data/checksums.sha256` and a full file manifest in `MANIFEST.json`.
|
| 34 |
- Croissant-style metadata in `croissant_metadata.json`.
|
| 35 |
|
| 36 |
-
## Main Files
|
| 37 |
|
| 38 |
| Path | Purpose |
|
| 39 |
|---|---|
|
|
@@ -51,19 +67,19 @@ The released data support held-out-pose evaluation, temporal-history sweeps, sen
|
|
| 51 |
| `scripts/reproduce_tables.py` | Copies stored summary CSVs into `tables/`. |
|
| 52 |
| `scripts/make_main_figures.py`, `scripts/make_supp_figures.py` | Recreate lightweight figures from stored CSV summaries. |
|
| 53 |
|
| 54 |
-
## What Is Not Included
|
| 55 |
|
| 56 |
The upstream fish-schooling ABM source code, DNS solver files, MATLAB simulator-query code, and simulator internals are not redistributed. This release is intended to reproduce benchmark evaluations from processed HDF5 files, not to regenerate the DNS-parameterized wake library from first principles.
|
| 57 |
|
| 58 |
-
## Intended Use
|
| 59 |
|
| 60 |
SparseWake is intended for evaluating sparse temporal physical sensing, hydrodynamic neighbor-state estimation, robustness under controlled flow-component and noise protocols, and reproducibility of benchmark-level evaluation summaries.
|
| 61 |
|
| 62 |
-
## Out-of-Scope Use
|
| 63 |
|
| 64 |
SparseWake should not be treated as a complete biological lateral-line model, a full natural fish-schooling simulator, a pressure/shear sensing dataset, a direct CFD replacement, or a validation dataset for multi-neighbor closed-loop schooling behavior.
|
| 65 |
|
| 66 |
-
## Data Structure
|
| 67 |
|
| 68 |
HDF5 arrays are stored in MATLAB-style or sample-first layouts depending on source export; `src/sparsewake/data.py` loads them sample-first. Core fields include:
|
| 69 |
|
|
@@ -78,7 +94,7 @@ HDF5 arrays are stored in MATLAB-style or sample-first layouts depending on sour
|
|
| 78 |
|
| 79 |
See `docs/data_fields.md` for the full schema and `docs/benchmark_protocol.md` for the split and feature protocol.
|
| 80 |
|
| 81 |
-
## Quick Start
|
| 82 |
|
| 83 |
```bash
|
| 84 |
python -m venv .venv
|
|
@@ -90,7 +106,7 @@ python scripts/reproduce_tables.py --results data/results --out tables
|
|
| 90 |
|
| 91 |
On Unix-like systems, use `.venv/bin/pip` and `.venv/bin/python`.
|
| 92 |
|
| 93 |
-
## Reproduce Stored Tables and Diagnostic Plots
|
| 94 |
|
| 95 |
```bash
|
| 96 |
python scripts/reproduce_tables.py --results data/results --out tables
|
|
@@ -99,11 +115,11 @@ python scripts/make_supp_figures.py --results data/results --out figures
|
|
| 99 |
```
|
| 100 |
|
| 101 |
These commands use stored summary CSV files and are intended for fast numerical verification and diagnostic plotting. Final manuscript figures may include manual layout adjustments and are not part of the dataset artifact.
|
| 102 |
-
## License
|
| 103 |
|
| 104 |
The SparseWake processed datasets, metadata, result summaries, documentation, and release utilities are made available under the Creative Commons Attribution 4.0 International license (CC BY 4.0). Upstream simulator source code and solver assets are not redistributed and are not covered by this dataset release.
|
| 105 |
|
| 106 |
-
## Citation
|
| 107 |
|
| 108 |
During anonymous review, cite this dataset as:
|
| 109 |
|
|
|
|
| 14 |
|
| 15 |
# SparseWake
|
| 16 |
|
| 17 |
+
SparseWake is a synthetic benchmark for sparse temporal hydrodynamic sensing.
|
| 18 |
+
|
| 19 |
+
## ICLR 2027 release
|
| 20 |
+
|
| 21 |
+
The expanded release adds controlled multi-source mixtures and common-prior nearest-source tasks, with complete core data banks, reference checkpoints, a small review supplement, and reproduction code with a frozen wake-library input.
|
| 22 |
+
|
| 23 |
+
**[Download release iclr2027-v1.0rc2](versions/iclr2027-v1.0rc2/README.md)**
|
| 24 |
+
|
| 25 |
+
The version page lists the three archives, exact sizes, checksums, extraction instructions, generation scope, and component licenses. Data and result tables are CC BY 4.0; new original code is MIT; historical and third-party components retain their supplied notices. The generation code supports sensing scenes based on the cited reduced-order model, not a complete free-swimming schooling simulator or DNS reproduction.
|
| 26 |
+
|
| 27 |
+
For reproducibility, record the release identifier and final immutable repository commit. The historical root-level manifest and metadata describe the May 2026 files; the new release has its own archive checksums and package manifests.
|
| 28 |
+
|
| 29 |
+
## Historical May 2026 release
|
| 30 |
+
|
| 31 |
+
The files and instructions below describe the original May 2026 release only. They are retained for compatibility; their inclusion and license statements do not override the expanded release documentation linked above.
|
| 32 |
+
|
| 33 |
SparseWake is an anonymous benchmark artifact for sparse temporal hydrodynamic sensing. It contains processed HDF5 datasets, metadata, summary CSV files, checksums, and lightweight Python scripts for inspecting the data and reproducing benchmark-level evaluation outputs.
|
| 34 |
+
### Dataset Summary
|
| 35 |
|
| 36 |
SparseWake evaluates whether sparse body-fixed temporal flow measurements can recover the relative state of a neighboring wake-producing fish in a controlled single-leader setting. The benchmark data are synthetic and were generated from a DNS-parameterized fish-schooling agent-based model. The artifact starts from processed HDF5 files and does not require the upstream simulator or high-fidelity solver.
|
| 37 |
|
| 38 |
The released data support held-out-pose evaluation, temporal-history sweeps, sensor-count ablations, component-separated flow inputs, common raw-noise stress tests, sample-size convergence checks, architecture screening summaries, and paired self-signal controls.
|
| 39 |
|
| 40 |
+
### What Is Included
|
| 41 |
|
| 42 |
- Full processed HDF5 benchmark datasets in `data/processed/`.
|
| 43 |
- A small sample HDF5 file in `data/sample/` for inspection and smoke tests.
|
|
|
|
| 49 |
- Checksums in `data/checksums.sha256` and a full file manifest in `MANIFEST.json`.
|
| 50 |
- Croissant-style metadata in `croissant_metadata.json`.
|
| 51 |
|
| 52 |
+
### Main Files
|
| 53 |
|
| 54 |
| Path | Purpose |
|
| 55 |
|---|---|
|
|
|
|
| 67 |
| `scripts/reproduce_tables.py` | Copies stored summary CSVs into `tables/`. |
|
| 68 |
| `scripts/make_main_figures.py`, `scripts/make_supp_figures.py` | Recreate lightweight figures from stored CSV summaries. |
|
| 69 |
|
| 70 |
+
### What Is Not Included
|
| 71 |
|
| 72 |
The upstream fish-schooling ABM source code, DNS solver files, MATLAB simulator-query code, and simulator internals are not redistributed. This release is intended to reproduce benchmark evaluations from processed HDF5 files, not to regenerate the DNS-parameterized wake library from first principles.
|
| 73 |
|
| 74 |
+
### Intended Use
|
| 75 |
|
| 76 |
SparseWake is intended for evaluating sparse temporal physical sensing, hydrodynamic neighbor-state estimation, robustness under controlled flow-component and noise protocols, and reproducibility of benchmark-level evaluation summaries.
|
| 77 |
|
| 78 |
+
### Out-of-Scope Use
|
| 79 |
|
| 80 |
SparseWake should not be treated as a complete biological lateral-line model, a full natural fish-schooling simulator, a pressure/shear sensing dataset, a direct CFD replacement, or a validation dataset for multi-neighbor closed-loop schooling behavior.
|
| 81 |
|
| 82 |
+
### Data Structure
|
| 83 |
|
| 84 |
HDF5 arrays are stored in MATLAB-style or sample-first layouts depending on source export; `src/sparsewake/data.py` loads them sample-first. Core fields include:
|
| 85 |
|
|
|
|
| 94 |
|
| 95 |
See `docs/data_fields.md` for the full schema and `docs/benchmark_protocol.md` for the split and feature protocol.
|
| 96 |
|
| 97 |
+
### Quick Start
|
| 98 |
|
| 99 |
```bash
|
| 100 |
python -m venv .venv
|
|
|
|
| 106 |
|
| 107 |
On Unix-like systems, use `.venv/bin/pip` and `.venv/bin/python`.
|
| 108 |
|
| 109 |
+
### Reproduce Stored Tables and Diagnostic Plots
|
| 110 |
|
| 111 |
```bash
|
| 112 |
python scripts/reproduce_tables.py --results data/results --out tables
|
|
|
|
| 115 |
```
|
| 116 |
|
| 117 |
These commands use stored summary CSV files and are intended for fast numerical verification and diagnostic plotting. Final manuscript figures may include manual layout adjustments and are not part of the dataset artifact.
|
| 118 |
+
### License
|
| 119 |
|
| 120 |
The SparseWake processed datasets, metadata, result summaries, documentation, and release utilities are made available under the Creative Commons Attribution 4.0 International license (CC BY 4.0). Upstream simulator source code and solver assets are not redistributed and are not covered by this dataset release.
|
| 121 |
|
| 122 |
+
### Citation
|
| 123 |
|
| 124 |
During anonymous review, cite this dataset as:
|
| 125 |
|