Add task category, fix typos, and improve documentation

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +40 -17
README.md CHANGED
@@ -1,39 +1,62 @@
1
  ---
2
- license: mit
3
  language:
4
  - en
5
- tags:
6
- - physcis
7
- - physcis-informed
8
  pretty_name: Neural Parametric Solver
 
 
 
 
 
9
  ---
10
 
11
- ## Learning a Neural Solver for Parametric PDE to Enhance Physics-Informed Methods
 
 
12
 
13
- This space provides the datasets used in the paper "Learning a Neural Solver for Parametric PDE to Enhance Physics-Informed Methods".
14
 
15
- - Project Page: https://2ailesb.github.io/paperpages/neural-solver.html
16
- - ArXiV: https://arxiv.org/abs/2410.06820
17
- - Code: https://github.com/2ailesB/neural-parametric-solver
 
 
 
 
 
 
 
 
 
18
 
19
  ### PDEs
20
  We provide 9 datasets:
21
- - Helmholtz equation 1d: 4 versions for this PDE with varying difficulties depending on the range of the parameter $\omega$.
22
  - (0.5, 3): toy
23
  - (0.5, 10): medium
24
  - (0.5, 50): hard
25
  - (-5, 55): used for OOD experiments
26
- - Poisson equation 1d: 2 versions of the Poisosn equation:
27
  - Scalar forcing term
28
  - Multiscale functional forcing term
29
- - Non-Linear Reaction Diffusion PDE 1d (temporal)
30
- - Advection PDE 1d (temporal): extracted from PDEBench datasets
31
- - Heat 2d (temporal)
32
 
33
- Please refer to our [paper](https://arxiv.org/abs/2410.06820) or [code](https://github.com/2ailesB/neural-parametric-solver) for additional details on the PDE, parameters range or Datasets and Dataloaders.
34
 
35
  ### What's inside the datasets
36
 
37
- Each dataset provide the PDE trajectory $u$ along with the PDE parameters, forcings terms (if involved), initial conditions (if involved), boundary conditions (if involved).
38
- The [torch Datasets](https://github.com/2ailesB/neural-parametric-solver/tree/main/ngd_datasets) associated class return the data under a list containing: (params, forcings, ic, bc), position x, solution u, index of the trajectory.
 
39
 
 
 
 
 
 
 
 
 
 
 
1
  ---
 
2
  language:
3
  - en
4
+ license: mit
 
 
5
  pretty_name: Neural Parametric Solver
6
+ task_categories:
7
+ - other
8
+ tags:
9
+ - physics
10
+ - physics-informed
11
  ---
12
 
13
+ # Learning a Neural Solver for Parametric PDE to Enhance Physics-Informed Methods
14
+
15
+ This repository provides the datasets used in the paper "[Learning a Neural Solver for Parametric PDE to Enhance Physics-Informed Methods](https://huggingface.co/papers/2410.06820)", presented at ICLR 2025.
16
 
17
+ [Project Page](https://2ailesb.github.io/paperpages/neural-solver.html) | [ArXiv](https://arxiv.org/abs/2410.06820) | [Code](https://github.com/2ailesB/neural-parametric-solver)
18
 
19
+ ### Usage
20
+
21
+ To use these datasets with the provided code, follow the setup instructions from the [official repository](https://github.com/2ailesB/neural-parametric-solver):
22
+
23
+ ```bash
24
+ # Setup
25
+ conda create -n neural-parametric-solver python=3.10.11
26
+ pip install -e .
27
+
28
+ # Example: Train a neural solver on the Helmholtz dataset
29
+ python3 main.py dataset=helmholtz exp.lr=0.01 model.input_bc=1 model.input_gradtheta=1
30
+ ```
31
 
32
  ### PDEs
33
  We provide 9 datasets:
34
+ - **Helmholtz equation 1d**: 4 versions for this PDE with varying difficulties depending on the range of the parameter $\omega$.
35
  - (0.5, 3): toy
36
  - (0.5, 10): medium
37
  - (0.5, 50): hard
38
  - (-5, 55): used for OOD experiments
39
+ - **Poisson equation 1d**: 2 versions of the Poisson equation:
40
  - Scalar forcing term
41
  - Multiscale functional forcing term
42
+ - **Non-Linear Reaction Diffusion PDE 1d (temporal)**
43
+ - **Advection PDE 1d (temporal)**: extracted from PDEBench datasets
44
+ - **Heat 2d (temporal)**
45
 
46
+ Please refer to the [paper](https://arxiv.org/abs/2410.06820) or [code](https://github.com/2ailesB/neural-parametric-solver) for additional details on the PDEs, parameter ranges, and Dataloaders.
47
 
48
  ### What's inside the datasets
49
 
50
+ Each dataset provides the PDE trajectory $u$ along with the PDE parameters, forcing terms (if involved), initial conditions (if involved), and boundary conditions (if involved).
51
+
52
+ The [torch Datasets](https://github.com/2ailesB/neural-parametric-solver/tree/main/ngd_datasets) associated class returns the data as a list containing: `(params, forcings, ic, bc)`, position `x`, solution `u`, and the index of the trajectory.
53
 
54
+ ### Citation
55
+ ```bibtex
56
+ @inproceedings{leboudec2024learning,
57
+ title={Learning a Neural Solver for Parametric PDE to Enhance Physics-Informed Methods},
58
+ author={Le Boudec, Lise and de Bezenac, Emmanuel and Serrano, Louis and Regueiro-Espino, Ramon Daniel and Yin, Yuan and Gallinari, Patrick},
59
+ booktitle={The Thirteenth International Conference on Learning Representations},
60
+ year={2025}
61
+ }
62
+ ```