Instructions to use allenai/ACE2-SHiELD with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Full Model Emulation
How to use allenai/ACE2-SHiELD with Full Model Emulation:
# No code snippets available yet for this library. # To use this model, check the repository files and the library's documentation. # Want to help? PRs adding snippets are welcome at: # https://github.com/huggingface/huggingface.js
- Notebooks
- Google Colab
- Kaggle
Add model, config, and README
#1
by brianhenn - opened
- ACE-logo.png +0 -0
- README.md +44 -1
- ace2_shield_ckpt.tar +3 -0
- inference_config.yaml +22 -0
ACE-logo.png
ADDED
|
README.md
CHANGED
|
@@ -1,3 +1,46 @@
|
|
| 1 |
---
|
| 2 |
-
license:
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
library_name: fme
|
| 4 |
---
|
| 5 |
+
|
| 6 |
+
<img src="ACE-logo.png" alt="Logo for the ACE Project" style="width: auto; height: 50px;">
|
| 7 |
+
|
| 8 |
+
# ACE2-SHiELD
|
| 9 |
+
|
| 10 |
+
Ai2 Climate Emulator (ACE) is a family of models designed to simulate atmospheric variability from the time scale of days to centuries.
|
| 11 |
+
|
| 12 |
+
**Disclaimer: ACE models are research tools and should not be used for operational climate predictions.**
|
| 13 |
+
|
| 14 |
+
ACE2-SHiELD is trained on output from [SHiELD](https://www.gfdl.noaa.gov/shield/), NOAA GFDL's physics-based atmospheric model, and is described in [ACE2: Accurately learning subseasonal to decadal atmospheric variability and forced responses](https://www.nature.com/articles/s41612-025-01090-0). As part of that paper, the repository containing training and evaluation scripts and configuration files used for this model is located [here](https://github.com/ai2cm/ace2-paper).
|
| 15 |
+
|
| 16 |
+
### Quick links
|
| 17 |
+
|
| 18 |
+
- π [Paper](https://www.nature.com/articles/s41612-025-01090-0)
|
| 19 |
+
- π» [Code](https://github.com/ai2cm/ace)
|
| 20 |
+
- π¬ [Docs](https://ai2-climate-emulator.readthedocs.io/en/stable/)
|
| 21 |
+
- π [All Models](https://huggingface.co/collections/allenai/ace-67327d822f0f0d8e0e5e6ca4)
|
| 22 |
+
|
| 23 |
+
### Inference quickstart
|
| 24 |
+
|
| 25 |
+
1. Download this repository for the model checkpoint. Download the forcing data and initial conditions from the [ACE2S-SHiELD+](https://huggingface.co/allenai/ACE2S-SHiELD-plus) repository β specifically the `forcing_data/amip/` directory (covering 1979β2021) and `initial_conditions/amip/ic.nc` (a single initial condition for 1979-01-01).
|
| 26 |
+
|
| 27 |
+
2. Update paths in the `inference_config.yaml`. Specifically, update `experiment_dir`, `checkpoint_path`, `initial_condition.path` and `forcing_loader.dataset.data_path`. Optionally, configure `data_writer.names` to select which output variables to save.
|
| 28 |
+
|
| 29 |
+
3. Install code dependencies with `pip install fme`.
|
| 30 |
+
|
| 31 |
+
4. Run inference with `python -m fme.ace.inference inference_config.yaml`.
|
| 32 |
+
|
| 33 |
+
See the [ACE docs](https://ai2-climate-emulator.readthedocs.io/en/stable/) for full details on configuring inference and output data.
|
| 34 |
+
|
| 35 |
+
### Data availability
|
| 36 |
+
|
| 37 |
+
**Forcing and initial condition data** for AMIP-style simulations are available in the [ACE2S-SHiELD+](https://huggingface.co/allenai/ACE2S-SHiELD-plus) repository. Forcing data covers 1979β2021 (`forcing_data/amip/`). A single initial condition for 1979-01-01 is available (`initial_conditions/amip/ic.nc`).
|
| 38 |
+
|
| 39 |
+
**Training and validation data** are not hosted on Hugging Face, but are available in a requester-pays Google Cloud Storage bucket at:
|
| 40 |
+
```
|
| 41 |
+
gs://ai2cm-public-requester-pays/2024-11-13-ai2-climate-emulator-v2-amip/data/c96-1deg-shield
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
### Strengths and weaknesses
|
| 45 |
+
|
| 46 |
+
The behavior of ACE2-SHiELD is similar to that of [ACE2-ERA5](https://huggingface.co/allenai/ACE2-ERA5) as described in the [ACE2 paper](https://www.nature.com/articles/s41612-025-01090-0). Please refer to that model card and paper for a detailed discussion of strengths and weaknesses.
|
ace2_shield_ckpt.tar
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:2debfee21a4cee81f34631c81539a7f312b9ea67a73cebd0f9b00cbe3cc23482
|
| 3 |
+
size 1823643243
|
inference_config.yaml
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
experiment_dir: /output_directory
|
| 2 |
+
n_forward_steps: 400
|
| 3 |
+
forward_steps_in_memory: 50
|
| 4 |
+
checkpoint_path: /ace2_shield_ckpt.tar
|
| 5 |
+
logging:
|
| 6 |
+
log_to_screen: true
|
| 7 |
+
log_to_wandb: false
|
| 8 |
+
log_to_file: true
|
| 9 |
+
project: ace
|
| 10 |
+
initial_condition:
|
| 11 |
+
path: /initial_conditions/amip/ic.nc
|
| 12 |
+
start_indices:
|
| 13 |
+
times:
|
| 14 |
+
- "1979-01-01T00:00:00"
|
| 15 |
+
forcing_loader:
|
| 16 |
+
dataset:
|
| 17 |
+
data_path: /forcing_data/amip
|
| 18 |
+
num_data_workers: 4
|
| 19 |
+
data_writer:
|
| 20 |
+
save_prediction_files: true
|
| 21 |
+
save_monthly_files: false
|
| 22 |
+
names: ["TMP2m", "VGRD10m", "PRATEsfc"]
|