Add model card
Browse files
README.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: cc-by-4.0
|
| 3 |
+
tags:
|
| 4 |
+
- ocean
|
| 5 |
+
- emulation
|
| 6 |
+
- climate
|
| 7 |
+
- weather
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
**Samudra 2**
|
| 11 |
+
|
| 12 |
+
<!-- Add a rollout animation here, e.g.:
|
| 13 |
+
<p align="center">
|
| 14 |
+
<img src="https://huggingface.co/M2LInES/Samudra2/resolve/main/samudra2_rollout.gif" >
|
| 15 |
+
</p>
|
| 16 |
+
-->
|
| 17 |
+
|
| 18 |
+
## Quick links
|
| 19 |
+
|
| 20 |
+
- 📃 [Paper](https://arxiv.org/abs/2606.02610)
|
| 21 |
+
- 💻 [Code](https://github.com/m2lines/Samudra)
|
| 22 |
+
- 💬 [Docs](https://m2lines.github.io/Samudra/docs/)
|
| 23 |
+
|
| 24 |
+
This repository contains the optimized (EMA) weights for **Samudra 2**, an autoregressive neural ocean emulator. Samudra 2 scales the original [Samudra](https://github.com/m2lines/Samudra) emulator from 1° to finer resolutions, producing stable multi-year global rollouts at 1°, 1/2°, and 1/4°. The model is trained on simulated data from the Geophysical Fluid Dynamics Laboratory (GFDL) ocean model configuration **OM4**, and predicts temperature, salinity, velocities, and sea surface height across depth levels.
|
| 25 |
+
|
| 26 |
+
Compared to its predecessor, Samudra 2 uses a wider ConvNeXt U-Net backbone and a dynamic variance-weighted loss that reweights output channels by prediction error, improving deep-ocean fields and enabling stable rollouts at higher resolution.
|
| 27 |
+
|
| 28 |
+
## Repository contents
|
| 29 |
+
|
| 30 |
+
This repo provides one exponential-moving-average checkpoint per resolution:
|
| 31 |
+
|
| 32 |
+
| Path | Resolution |
|
| 33 |
+
| --- | --- |
|
| 34 |
+
| `onedeg/ema_ckpt.pt` | 1° |
|
| 35 |
+
| `quarterdeg/ema_ckpt.pt` | 1/4° |
|
| 36 |
+
| `halfdeg/ema_ckpt.pt` | 1/2° |
|
| 37 |
+
|
| 38 |
+
## Download
|
| 39 |
+
|
| 40 |
+
Download a single resolution (recommended) or the whole repo with the Hugging Face CLI:
|
| 41 |
+
|
| 42 |
+
$ pip install -U "huggingface_hub"
|
| 43 |
+
# one resolution
|
| 44 |
+
$ hf download M2LInES/Samudra2 onedeg/ema_ckpt.pt --local-dir ./Samudra2
|
| 45 |
+
# or the full repository
|
| 46 |
+
$ hf download M2LInES/Samudra2 --local-dir ./Samudra2
|
| 47 |
+
|
| 48 |
+
Or from Python:
|
| 49 |
+
|
| 50 |
+
```python
|
| 51 |
+
from huggingface_hub import hf_hub_download
|
| 52 |
+
import torch
|
| 53 |
+
|
| 54 |
+
ckpt_path = hf_hub_download("M2LInES/Samudra2", "onedeg/ema_ckpt.pt")
|
| 55 |
+
state = torch.load(ckpt_path, map_location="cpu")
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
## Usage
|
| 59 |
+
|
| 60 |
+
Set up the Samudra environment and load a checkpoint into the model. See the
|
| 61 |
+
[documentation](https://m2lines.github.io/Samudra/docs/) for the full quick-start,
|
| 62 |
+
config files for each resolution, and rollout/evaluation examples.
|
| 63 |
+
|
| 64 |
+
$ git clone https://github.com/m2lines/Samudra.git
|
| 65 |
+
$ cd Samudra
|
| 66 |
+
$ uv sync --dev
|
| 67 |
+
$ source .venv/bin/activate
|
| 68 |
+
|
| 69 |
+
## Citation
|
| 70 |
+
|
| 71 |
+
If you use Samudra 2, please cite:
|
| 72 |
+
|
| 73 |
+
```bibtex
|
| 74 |
+
@article{yuan2026samudra2,
|
| 75 |
+
title = {Samudra 2: Scaling Ocean Emulators across Resolutions},
|
| 76 |
+
author = {Yuan, Yuan and Rusak, Jesse and Merose, Alexander and Subel, Adam and
|
| 77 |
+
Perezhogin, Pavel and Adcroft, Alistair and Fernandez-Granda, Carlos and
|
| 78 |
+
Zanna, Laure},
|
| 79 |
+
journal = {arXiv preprint arXiv:2606.02610},
|
| 80 |
+
year = {2026},
|
| 81 |
+
url = {https://arxiv.org/abs/2606.02610}
|
| 82 |
+
}
|
| 83 |
+
```
|