Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update examples README.md and re-organize examples #708

Merged
merged 9 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 64 additions & 23 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,47 +7,88 @@ This repository provides sample applications demonstrating use of specific Physi
model architectures that are easy to train and deploy. These examples aim to show how
such models can help solve real world problems.

## CFD
## Introductory examples for learning key ideas

|Use case|Concepts covered|
| --- | --- |
|[Darcy Flow](./cfd/darcy_fno/)|Introductory example for learning basics of data-driven models on Physics-ML datasets|
|[Darcy Flow (Data + Physics)](./cfd/darcy_physics_informed/)|Data-driven training with physics-based constraints|
|[Lid Driven Cavity Flow](./cfd/ldc_pinns/)|Purely physics-driven (no external simulation/experimental data) training|
|[Vortex Shedding](./cfd/vortex_shedding_mgn/)|Introductory example for learning the basics of MeshGraphNets in Modulus|
|[Medium-range global weather forecast using FCN-AFNO](./weather/fcn_afno/)|Introductory example on training data-driven models for global weather forecasting (auto-regressive model)|
|[Lagrangian Fluid Flow](./cfd/lagrangian_mgn/)|Introductory example for data-driven training on Lagrangian meshes|
|[Stokes Flow (Physics Informed Fine-Tuning)](./cfd/stokes_mgn/)|Data-driven training followed by physics-based fine-tuning|

## Domain-specific examples

The several examples inside Modulus can be classified based on their domains as below:

> **NOTE:** The below classification is not exhaustive by any means! One can classify single example into multiple domains and we encourage the users to review the entire list.

> **NOTE:** * Indicates externally contributed examples.

### CFD

|Use case|Model|Transient|
| --- | --- | --- |
|[Vortex Shedding](./cfd/vortex_shedding_mgn/)|MeshGraphNet|YES|
|[Ahmed Body Drag prediction](./cfd/ahmed_body_mgn/)|MeshGraphNet|NO|
|[Drag prediction - External Aero](./cfd/external_aerodynamics/)|MeshGraphNet, UNet, DoMINO, FigConvNet|NO|
|[Navier-Stokes Flow](./cfd/navier_stokes_rnn/)|RNN|YES|
|[Gray-Scott System](./cfd/gray_scott_rnn/)|RNN|YES|
|[Darcy Flow](./cfd/darcy_fno/)|FNO|NO|
|[Lagrangian Fluid Flow](./cfd/lagrangian_mgn/)|MeshGraphNet|YES|
|[Darcy Flow using Nested-FNOs](./cfd/darcy_nested_fnos/)|Nested-FNO|NO|
|[Darcy Flow using Transolver*](./cfd/darcy_transolver/)|Transolver (Transformer-based)|NO|
|[Darcy Flow (Data + Physics Driven) using DeepONet approach](./cfd/darcy_physics_informed/)|FNO (branch) and MLP (trunk)|NO|
|[Darcy Flow (Data + Physics Driven) using PINO approach (Numerical gradients)](./cfd/darcy_physics_informed/)|FNO|NO|
|[Stokes Flow (Physics Informed Fine-Tuning)](./cfd/stokes_mgn/)|MeshGraphNet and MLP|NO|
|[Lid Driven Cavity Flow](./cfd/ldc_pinns/)|MLP|NO
|[Magnetohydrodynamics using PINO (Data + Physics Driven)*](./cfd/mhd_pino/)|FNO|YES|
|[Shallow Water Equations using PINO (Data + Physics Driven)*](./cfd/swe_nonlinear_pino/)|FNO|YES|
|[Shallow Water Equations using Distributed GNNs](./cfd/swe_distributed_gnn/)|GraphCast|YES|
|[Vortex Shedding with Temporal Attention](./cfd/vortex_shedding_mesh_reduced/)|MeshGraphNet|YES|

## Weather

|Use case|Model|AMP|CUDA Graphs|Multi-GPU| Multi-Node|
| --- | --- | --- | --- | --- | --- |
|[Medium-range global weather forecast using FCN-SFNO](https://github.com/NVIDIA/modulus-makani)|FCN-SFNO|YES|NO|YES|YES|
|[Medium-range global weather forecast using GraphCast](./weather/graphcast/)|GraphCast|YES|NO|YES|YES|
|[Medium-range global weather forecast using FCN-AFNO](./weather/fcn_afno/)|FCN-AFNO|YES|YES|YES|YES|
|[Medium-range and S2S global weather forecast using DLWP](./weather/dlwp/)|DLWP|YES|YES|YES|YES|
### Weather

## Healthcare
|Use case|Model|
| --- | --- |
|[Medium-range global weather forecast using FCN-SFNO](https://github.com/NVIDIA/modulus-makani)|FCN-SFNO|
|[Medium-range global weather forecast using GraphCast](./weather/graphcast/)|GraphCast|
|[Medium-range global weather forecast using FCN-AFNO](./weather/fcn_afno/)|FCN-AFNO|
|[Medium-range and S2S global weather forecast using DLWP](./weather/dlwp/)|DLWP|
|[Medium-range and S2S global weather forecast using DLWP-HEALPix](./weather/dlwp_healpix/)|DLWP-HEALPix|
|[Medium-range and S2S global weather forecast using DLWP-HEALPix](./weather/dlwp_healpix_coupled/)|DLWP-HEALPix|
|[Medium-range and S2S global weather forecast using Pangu](./weather/pangu_weather/)|Pangu|
|[Diagonistic (Precipitation) model using AFNO](./weather/diagnostic/)|AFNO|
|[Unified Recipe for training several Global Weather Forecasting models](./weather/unified_recipe/)|AFNO, FCN-SFNO, GraphCast|

|Use case|Model|Transient|
| --- | --- | --- |
|[Cardiovascular Simulations](./healthcare/bloodflow_1d_mgn/)|MeshGraphNet|YES|
|[Brain Anomaly Detection](./healthcare/brain_anomaly_detection/)|FNO|YES|
### Generative

## Molecular Dymanics
|Use case|Model|
| --- | --- |
|[Generative Correction Diffusion Model for Km-scale Atmospheric Downscaling](./generative/corrdiff/)|CorrDiff|
|[StormCast: Generative Diffusion Model for Km-scale, Convection allowing Model Emulation](./generative/stormcast/)|CorrDiff|
|[Fluid Super-resolution*](./generative/diffusion/)|Diffusion|

|Use case|Model|Transient|
| --- | --- | --- |
|[Force Prediciton for Lennard Jones system](./molecular_dynamics/lennard_jones/)|MeshGraphNet|NO|
### Healthcare

|Use case|Model|
| --- | --- |
|[Cardiovascular Simulations*](./healthcare/bloodflow_1d_mgn/)|MeshGraphNet|
|[Brain Anomaly Detection](./healthcare/brain_anomaly_detection/)|FNO|

### Additive Manufacturing

|Use case|Model|
| --- | --- |
|[Metal Sintering Simulation*](./additive_manufacturing/sintering_physics/)|MeshGraphNet|

### Molecular Dymanics

## Generative
|Use case|Model|
| --- | --- |
|[Force Prediciton for Lennard Jones system](./molecular_dynamics/lennard_jones/)|MeshGraphNet|

|Use case|Model|Multi-GPU| Multi-Node|
| --- | --- | --- | --- |
|[Generative Correction Diffusion Model for Km-scale Atmospheric Downscaling](./generative/corrdiff/)|CorrDiff|YES|YES|

## Additional examples

Expand Down