Skip to content

Commit

Permalink
Dmg build (#18)
Browse files Browse the repository at this point in the history
* update dmg

* update dmg
  • Loading branch information
leoglonz authored Dec 6, 2024
1 parent cc1a542 commit 15d7235
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 7 deletions.
3 changes: 3 additions & 0 deletions docs/codes/lonzarich_2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## The Generic, Scalable Differentiable Modeling Framework
<!-- ![Alt text](../assets/project-figures/dMG.png) -->

[Code Release][dmg_code]

`𝛿MG` is a domain-agnostic, PyTorch-based framework for developing trainable differentiable models that merge neural networks with process-based equations.

Expand All @@ -22,3 +23,5 @@ In 𝛿MG, we define a differentiable model with the class *DeltaModel* that can
- **phy_model**: The physical model written in PyTorch (or potentially another interoperable differentiable platform) that takes learnable outputs from the `nn` model(s) and returns a prediction of some target variable(s). This can also be a wrapper holding several physical models.

The *DeltaModel* object can be trained and forwarded just as any other PyTorch model (nn.Module).

[dmg_code]: ../dmg/code.md
2 changes: 1 addition & 1 deletion docs/dmg/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For [tutorials](https://github.com/mhpi/generic_deltaModel/tree/master/example)
<br>


# Getting Started with *HydroDL 2.0*
# Getting Started with *𝛿MG* + *HydroDL 2.0*

## System Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/dmg/detail.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ According to this schema, we define these core classes, from bottom up:
│ │ ├── data/ # Data processing
│ │ └── utils/ # Helper functions
│ ├── models/
│ │ ├── differentiable_model.py # Differentiable model definition
│ │ ├── differentiable_model.py # Differentiable model definition DeltaModel
│ │ ├── model_handler.py # High-level model manager
│ │ ├── loss_functions/ # Custom loss functions
│ │ └── neural_networks/ # Neural network architectures
Expand Down
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,6 @@ markdown_extensions:

nav:
- HydroDL: index.md
- 𝛿MG:
- Overview: codes/lonzarich_2024.md
- Details: dmg/detail.md
- Code Release: dmg/code.md
- Benchmarks:
- benchmarks/index.md
- Getting started:
Expand All @@ -155,7 +151,11 @@ nav:
- Stream-Temperature: codes/Rahmani_et_al_2021.md
- diff-Stream-Temperature: codes/Rahmani_et_al_2023.md
- Transformer: codes/liu_2024.md

- Framework:
- 𝛿MG:
- Overview: codes/lonzarich_2024.md
- Details: dmg/detail.md
- Code Release: dmg/code.md

extra_javascript:
# - javascripts/plots.js
Expand Down

0 comments on commit 15d7235

Please sign in to comment.