Add English model card
Browse files
README.md
ADDED
|
@@ -0,0 +1,136 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
tags:
|
| 6 |
+
- OneScience
|
| 7 |
+
- Earth Science
|
| 8 |
+
- Soil Moisture
|
| 9 |
+
- Drought Forecasting
|
| 10 |
+
- Subseasonal Forecasting
|
| 11 |
+
- Ensemble Forecasting
|
| 12 |
+
frameworks: PyTorch
|
| 13 |
+
---
|
| 14 |
+
|
| 15 |
+
<p align="center"><strong><span style="font-size: 30px;">RISE-UNet</span></strong></p>
|
| 16 |
+
|
| 17 |
+
# Model Introduction
|
| 18 |
+
|
| 19 |
+
RISE-UNet combines deep learning and dynamical forecasts for subseasonal root-zone soil-moisture prediction. It recursively predicts five weekly anomalies and evaluates drought probabilities through ensembles.
|
| 20 |
+
|
| 21 |
+
Paper: Skillful subseasonal soil moisture drought forecasts with deep learning-dynamic models
|
| 22 |
+
https://doi.org/10.1038/s41467-025-62761-3
|
| 23 |
+
|
| 24 |
+
# Model Description
|
| 25 |
+
|
| 26 |
+
The model was proposed by researchers at Auburn University. It was trained with GLEAM root-zone soil moisture, ERA5 reanalysis, and GEFSv12 and ECMWF S2S reforecasts. By combining residual, inception, squeeze-and-excitation, and UNet++ operations with recursive predictions, it supports weekly root-zone soil-moisture and flash-drought forecasting over the contiguous United States, China, and Australia.
|
| 27 |
+
|
| 28 |
+
# Use Cases
|
| 29 |
+
|
| 30 |
+
| Use Case | Description |
|
| 31 |
+
| :---: | :--- |
|
| 32 |
+
| Subseasonal soil moisture | Predict root-zone soil-moisture anomalies for weeks 1–5. |
|
| 33 |
+
| Drought forecasting | Identify events below the twentieth percentile. |
|
| 34 |
+
| Ensemble forecasting | Use 11 dynamical members and stochastic inference dropout. |
|
| 35 |
+
| Hybrid modeling | Fuse reanalysis and dynamical reforecasts. |
|
| 36 |
+
| ModelScope/OneCode execution | Validate structured data, training, inference, probabilistic precipitation metrics, and visualization in ModelScope or OneCode. |
|
| 37 |
+
| Multi-GPU training | Start multi-process training through `torchrun`. |
|
| 38 |
+
|
| 39 |
+
# Usage Instructions
|
| 40 |
+
|
| 41 |
+
## Download
|
| 42 |
+
|
| 43 |
+
```bash
|
| 44 |
+
hf download OneScience-Group/RISE-UNet --local-dir ./RISE-UNet
|
| 45 |
+
cd RISE-UNet
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
### Environment Dependencies
|
| 49 |
+
|
| 50 |
+
**Hardware Requirements**
|
| 51 |
+
|
| 52 |
+
- A GPU or DCU is recommended.
|
| 53 |
+
- A CPU can run the default small-sample connectivity configuration.
|
| 54 |
+
- DCU users should install DTK 25.04.2 or a compatible OneScience-recommended version first.
|
| 55 |
+
|
| 56 |
+
**DCU Environment**
|
| 57 |
+
|
| 58 |
+
```bash
|
| 59 |
+
# Activate DTK and Conda first
|
| 60 |
+
conda create -n onescience311 python=3.11 -y
|
| 61 |
+
conda activate onescience311
|
| 62 |
+
pip install onescience[earth-dcu] -i http://mirrors.onescience.ai:3141/pypi/simple/ --trusted-host mirrors.onescience.ai
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
**GPU Environment**
|
| 66 |
+
|
| 67 |
+
```bash
|
| 68 |
+
# Activate Conda first
|
| 69 |
+
conda create -n onescience311 python=3.11 -y libstdcxx-ng=12 libgcc-ng=12 gcc_linux-64=12 gxx_linux-64=12
|
| 70 |
+
conda activate onescience311
|
| 71 |
+
pip install onescience[earth-gpu] -i http://mirrors.onescience.ai:3141/pypi/simple/ --trusted-host mirrors.onescience.ai
|
| 72 |
+
```
|
| 73 |
+
|
| 74 |
+
## Synthetic Data
|
| 75 |
+
|
| 76 |
+
The paper uses a `48x96` 0.5-degree regional grid, 11 ensemble members, weekly historical and forecast variables, and GLEAM 0–100 cm root-zone soil-moisture anomalies as targets. Synthetic data preserve the grid, member count, recursive five-week protocol, and RISE operators while reducing initialization count, width, and epochs. Results verify the workflow only and do not represent paper performance.
|
| 77 |
+
|
| 78 |
+
```bash
|
| 79 |
+
python scripts/fake_data.py
|
| 80 |
+
```
|
| 81 |
+
|
| 82 |
+
## Training
|
| 83 |
+
|
| 84 |
+
```bash
|
| 85 |
+
python scripts/train.py
|
| 86 |
+
torchrun --nproc_per_node=2 --nnodes=1 --master_addr="localhost" --master_port=29500 scripts/train.py
|
| 87 |
+
```
|
| 88 |
+
|
| 89 |
+
The default synthetic run completes five-week recursive optimization, deep-supervision losses, and the ensemble-spread constraint, and both single-process and two-process DDP training have been verified. It produces one recoverable checkpoint and records the CRPSexp training result. Training results are saved to:
|
| 90 |
+
|
| 91 |
+
```text
|
| 92 |
+
result/checkpoints/rise_unet.pt
|
| 93 |
+
result/training/metrics.json
|
| 94 |
+
```
|
| 95 |
+
|
| 96 |
+
## Weights
|
| 97 |
+
|
| 98 |
+
The paper's code is available at https://osf.io/6y4kh/, but an independently licensed official pretrained checkpoint was not confirmed.
|
| 99 |
+
|
| 100 |
+
## Inference
|
| 101 |
+
|
| 102 |
+
```bash
|
| 103 |
+
python scripts/inference.py
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
Inference restores the checkpoint, retains stochastic dropout, and recursively generates weeks 1–5 for 11 members. The output shape is `[11,5,48,96]` and has passed finite-value checks. Inference results are saved to:
|
| 107 |
+
|
| 108 |
+
```text
|
| 109 |
+
result/output/predictions.npz
|
| 110 |
+
```
|
| 111 |
+
|
| 112 |
+
## Evaluation
|
| 113 |
+
|
| 114 |
+
```bash
|
| 115 |
+
python scripts/result.py
|
| 116 |
+
```
|
| 117 |
+
|
| 118 |
+
Evaluation computes weekly ACC, CRPS, and drought GSS and creates a week-3 spatial error figure. All metrics are finite, and the PNG has passed format and non-empty-pixel checks; synthetic results do not represent paper performance. Evaluation results are saved to:
|
| 119 |
+
|
| 120 |
+
```text
|
| 121 |
+
result/evaluation/metrics.json
|
| 122 |
+
result/evaluation/comparison.png
|
| 123 |
+
```
|
| 124 |
+
|
| 125 |
+
# Official OneScience Information
|
| 126 |
+
|
| 127 |
+
| Platform | OneScience | OneSkills |
|
| 128 |
+
|---|---|---|
|
| 129 |
+
| Gitee | https://gitee.com/onescience-ai/onescience | https://gitee.com/onescience-ai/oneskills |
|
| 130 |
+
| GitHub | https://github.com/onescience-ai/OneScience | https://github.com/onescience-ai/oneskills |
|
| 131 |
+
|
| 132 |
+
# Citation and License
|
| 133 |
+
|
| 134 |
+
This repository is an independent engineering reproduction of the public RISE-UNet specifications, with code licensed under the Apache License 2.0.
|
| 135 |
+
|
| 136 |
+
The original paper is licensed under CC BY-NC-ND 4.0; the paper and GLEAM, ERA5, GEFSv12, and ECMWF S2S data remain subject to their respective licenses and terms.
|