Wildfire-FM / docs /huggingface_release_design.md
yx21e's picture
Remove manuscript TeX and table source artifacts
d3bbb53 verified

Hugging Face Release Design

This release follows a model-card-first pattern used by geospatial and weather foundation-model releases on the Hub. The public page starts with model purpose, released weights, input expectations, a quick loading example, data boundaries, and a compact evaluation snapshot. Paper artifacts are included as supporting reproducibility material rather than being the main organizing principle.

Public Card Structure

  • README.md is the public model card. It contains YAML metadata, intended use, checkpoint locations, quick loading code, data-source boundaries, limitations, and citation text.
  • assets/ contains lightweight visuals for the Hub page plus PNG previews of final-paper figure previews.
  • models/wildfire_fm/ contains model code, manifests, and checkpoint metadata.
  • paper_outputs/ stores selected final-paper figure PDFs only. Manuscript TeX, table TeX, TikZ source, BibTeX, and paper PDF files are not included.
  • artifacts/results/ stores sanitized compact CSV/JSON summaries that can be public.
  • data_sources/ documents external data resources without redistributing them.
  • experiments/ contains raw-rerun reference scripts and Slurm templates.

Data Boundary

The repository is a model release with reproducibility artifacts, not a raw-data mirror. Full raw-data reruns require separately obtained source data, local feature caches, and cluster-specific paths.

Manuscript Boundary

The Hub model release intentionally excludes manuscript TeX, BibTeX, table TeX, TikZ source, and paper PDFs. The paper can be linked separately after the public arXiv version is finalized.