Add template bank benchmark data

README.md

@@ -1,3 +1,76 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-4.0
+---
+
+# gwBenchmarks Dataset Files
+
+This repository hosts dataset artifacts for the `gwBenchmarks` codebase:
+
+```text
+https://github.com/tousifislam/gwBenchmarks
+```
+
+The GitHub repository contains benchmark code, curation scripts, prompts, and
+evaluators. This Hugging Face dataset repository stores the binary benchmark
+artifacts that should not be committed to GitHub.
+
+## Directory Layout
+
+Use one top-level directory per benchmark:
+
+```text
+waveform/
+remnant/
+dynamics/
+ringdown/
+analytic/
+validity/
+template_bank/
+```
+
+Each benchmark directory should contain:
+
+- the data files used by that benchmark
+- a short `README.md` describing file names, shapes, and provenance
+- checksums or generation details when available
+
+Recommended file names match the paths expected by `gwBenchmarks`:
+
+```text
+waveform/waveform_training.h5
+waveform/waveform_validation.h5
+remnant/remnant_training.h5
+remnant/remnant_validation.h5
+dynamics/dynamics_training.h5
+dynamics/dynamics_validation.h5
+ringdown/ringdown_training.h5
+ringdown/ringdown_validation.h5
+analytic/analytic_training.h5
+analytic/analytic_validation.h5
+validity/validity_training.h5
+validity/validity_validation.h5
+template_bank/f_amp.npy
+template_bank/Aref_weights.npy
+template_bank/bank_wf_params.npy
+template_bank/bank_wf_params_test.npy
+template_bank/calpha_grid_params.npy
+```
+
+## Uploading New Benchmark Data
+
+Clone this dataset repository, add files under the appropriate benchmark
+directory, and push:
+
+```bash
+git clone https://huggingface.co/datasets/GWagents/gwBenchmarks
+cd gwBenchmarks
+mkdir -p waveform
+cp /path/to/waveform_training.h5 waveform/
+cp /path/to/waveform_validation.h5 waveform/
+git add waveform
+git commit -m "Add waveform benchmark data"
+git push
+```
+
+The repository uses Git LFS for binary artifacts including `.h5`, `.hdf5`,
+`.npy`, and `.npz` files.

template_bank/Aref_weights.npy

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2429928286e2245d3a53f6b87cf5aeb56a8f28ecae4a8fd1e4389c280b68b733
+size 48128

template_bank/README.md

@@ -0,0 +1,38 @@
+# Template Bank Benchmark Files
+
+These files support the `template_bank` benchmark in `GWagents/gwBenchmarks`.
+
+## Files
+
+- `f_amp.npy`: frequency grid in Hz, shape `(3000,)`
+- `Aref_weights.npy`: amplitude reference and overlap weights, shape `(2, 3000)`
+- `bank_wf_params.npy`: public 4D parameter pool, shape `(8574, 4)`
+- `bank_wf_params_test.npy`: hidden/local evaluation 4D parameter pool, shape `(1000, 4)`
+- `calpha_grid_params.npy`: literature-reference parameter grid, shape `(9, 4)`
+
+Submitted template-bank rows use five parameters:
+
+```text
+[m1, m2, s1z, s2z, phi_ref]
+```
+
+The public and hidden parameter pools omit `phi_ref`; benchmark evaluators append
+deterministic phases when generating evaluation waveforms.
+
+## Expected Code Paths
+
+In a local `gwBenchmarks` checkout, these files should be placed under:
+
+```text
+datasets/template_bank/
+```
+
+The evaluator expects:
+
+```text
+datasets/template_bank/f_amp.npy
+datasets/template_bank/Aref_weights.npy
+datasets/template_bank/bank_wf_params.npy
+datasets/template_bank/bank_wf_params_test.npy
+datasets/template_bank/calpha_grid_params.npy
+```

template_bank/bank_wf_params.npy

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4cc133da0b789dc85da961917acff5f1a473aa73bd4a786fd4eb31c550d47314
+size 274496

template_bank/bank_wf_params_test.npy

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7192bb5afc536b24bfb182d31e1950291250b1eb58d64e82d3e6ed74df62ca35
+size 32128

template_bank/calpha_grid_params.npy

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:125672ce0a760013cfd53922ad34de42f80412b7f1c78e8a61cfa193ddc3f576
+size 416

template_bank/f_amp.npy

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3712b44852a5da6d94e3159641b2eff4124475e1b3d529046812a489ec9159b1
+size 24128