zhangrenchao commited on
Commit
78aaa51
·
verified ·
1 Parent(s): 48fc6c1

Add English model card

Browse files
Files changed (1) hide show
  1. README.md +57 -0
README.md ADDED
@@ -0,0 +1,57 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
+ tags:
6
+ - OneScience
7
+ - Earth Science
8
+ - Hydrology
9
+ - Differentiable Physics
10
+ - Ungauged Basins
11
+ - Climate Trends
12
+ frameworks: PyTorch
13
+ ---
14
+ <p align="center"><strong><span style="font-size: 30px;">Delta-HBV</span></strong></p>
15
+ # Model Introduction
16
+ Delta-HBV is a differentiable, mass-conserving, physics-informed hydrological model with dynamic parameter learning.
17
+
18
+ Paper: The suitability of differentiable, physics-informed machine learning hydrologic models for ungauged regions and climate change impact assessment
19
+ https://doi.org/10.5194/hess-27-2357-2023
20
+ # Model Description
21
+ The model was proposed by Pennsylvania State University and KAUST. It was trained with CAMELS daily forcing, 35 basin attributes, and streamflow. An LSTM drives 16 parallel HBV components and dynamic beta and gamma parameters for ungauged-basin and historical-trend assessment.
22
+ # Use Cases
23
+ | Use Case | Description |
24
+ |---|---|
25
+ | Ungauged hydrology | Evaluate spatially held-out streamflow. |
26
+ | Physical variables | Predict discharge and evapotranspiration. |
27
+ | Ungauged regions | Test extrapolation to contiguous held-out regions. |
28
+ | Historical trends | Assess annual and high/low-flow trend preservation. |
29
+ | ModelScope/OneCode execution | Validate data, training, inference, metrics, and visualization. |
30
+ | Multi-GPU training | Start multi-process training through `torchrun`. |
31
+ # Usage Instructions
32
+ Use a GPU or DCU when available; CPU supports the default smoke configuration.
33
+ ```bash
34
+ hf download OneScience-Group/Delta-HBV --local-dir ./Delta-HBV
35
+ cd Delta-HBV
36
+ python scripts/fake_data.py
37
+ ```
38
+ For single-process training, use:
39
+ ```bash
40
+ python scripts/train.py
41
+ ```
42
+ For multi-process training, use:
43
+ ```bash
44
+ torchrun --standalone --nproc_per_node=2 scripts/train.py
45
+ ```
46
+ Run inference and evaluation with:
47
+ ```bash
48
+ python scripts/inference.py
49
+ python scripts/result.py
50
+ ```
51
+ Training optimizes streamflow after a 365-day warm-up. Inference produces finite 730-day discharge and ET sequences; evaluation reports NSE, ET RMSE, and trend error.
52
+ ## Trained Weights
53
+ No weights are bundled under `weight/`. The paper does not provide a directly loadable official pretrained checkpoint, so no weight link is listed; the authors' code archive is not presented as model weights.
54
+ # Citation and License
55
+ This repository is an independent engineering reproduction of the public Delta-HBV specifications.
56
+
57
+ The original paper is licensed under CC BY 4.0; the original paper, official code, CAMELS, and MODIS data remain subject to their respective licenses and terms.