yx21e commited on
Commit
ebac98c
·
verified ·
1 Parent(s): bee9bc1

Add FireWx-FM input channel contract

Browse files
Files changed (1) hide show
  1. README.md +21 -1
README.md CHANGED
@@ -195,6 +195,24 @@ This Hub repository is model-first. It provides the released weights, model-load
195
  | Data access path | Source links and roles documented in `data_sources/` |
196
  | Paper artifact path | Compiled PDF in `paper/`; manuscript source managed in the authors' paper workspace |
197
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
198
  ---
199
 
200
  ## Hugging Face Release
@@ -204,6 +222,7 @@ This Hub repository is a model release with paper-aligned reproducibility artifa
204
  | Folder | Purpose | Example |
205
  |---|---|---|
206
  | `models/wildfire_fm/` | Model code, manifests, checkpoint metadata | `models/wildfire_fm/modeling_unet.py` |
 
207
  | `models/wildfire_fm/checkpoints/` | Five seeded PyTorch checkpoints | `seed_1/best_firms_prauc.pt` |
208
  | `paper/` | Compiled paper PDF | `wildfire_fm_evaluation_contracts.pdf` |
209
  | `assets/` | Hub-page visuals and final-paper previews | `selection_regret_final.png` |
@@ -254,7 +273,8 @@ Verify the public release artifacts:
254
  python3 scripts/reproduce_paper_outputs.py
255
  ```
256
 
257
- The checkpoint expects the same 16-channel gridded input described in the paper and in `data_sources/DATA_SOURCES.md`.
 
258
 
259
  ---
260
 
 
195
  | Data access path | Source links and roles documented in `data_sources/` |
196
  | Paper artifact path | Compiled PDF in `paper/`; manuscript source managed in the authors' paper workspace |
197
 
198
+ ### Input Channel Contract
199
+
200
+ The pretrained checkpoints expect a fixed 16-channel tensor in `[channel, y, x]`
201
+ order. Channel order matters.
202
+
203
+ | Channels | Names | Source |
204
+ |---:|---|---|
205
+ | 0-9 | `t2m`, `d2m`, `u10`, `v10`, `cape`, `sp`, `blh`, `vis`, `prate`, `tp` | NOAA HRRR |
206
+ | 10 | `firewx_valid` | Dynamic/input validity mask for this regional cache |
207
+ | 11 | `static_valid` | Static reprojection validity mask |
208
+ | 12-15 | `fuel_fbfm40`, `canopy_cover`, `housing_density`, `population` | LANDFIRE, WRC housing density, LandScan |
209
+
210
+ FIRMS provides the occupancy target, not an input channel. WFIGS and MTBS are
211
+ used for supporting event-level tasks and are not part of the 16-channel
212
+ pretrained occupancy input. Full channel-level details are in
213
+ `data_sources/DATA_SOURCES.md`; the same contract is available as
214
+ `models/wildfire_fm/input_channels.json`.
215
+
216
  ---
217
 
218
  ## Hugging Face Release
 
222
  | Folder | Purpose | Example |
223
  |---|---|---|
224
  | `models/wildfire_fm/` | Model code, manifests, checkpoint metadata | `models/wildfire_fm/modeling_unet.py` |
225
+ | `models/wildfire_fm/input_channels.json` | Machine-readable 16-channel input contract | `models/wildfire_fm/input_channels.json` |
226
  | `models/wildfire_fm/checkpoints/` | Five seeded PyTorch checkpoints | `seed_1/best_firms_prauc.pt` |
227
  | `paper/` | Compiled paper PDF | `wildfire_fm_evaluation_contracts.pdf` |
228
  | `assets/` | Hub-page visuals and final-paper previews | `selection_regret_final.png` |
 
273
  python3 scripts/reproduce_paper_outputs.py
274
  ```
275
 
276
+ The checkpoint expects the same fixed-order 16-channel gridded input described
277
+ above and in `data_sources/DATA_SOURCES.md`.
278
 
279
  ---
280