DeepXDE is a deep learning library on top of TensorFlow. Use DeepXDE if you need a deep learning library that
- solves forward and inverse partial differential equations (PDEs) via physics-informed neural network (PINN),
- solves forward and inverse integro-differential equations (IDEs) via PINN,
- solves forward and inverse fractional partial differential equations (fPDEs) via fractional PINN (fPINN),
- approximates functions from multi-fidelity data via multi-fidelity NN (MFNN),
- approximates nonlinear operators via deep operator network (DeepONet),
- approximates functions from a dataset with/without constraints.
Documentation: ReadTheDocs, SIAM Rev., Slides, Video
Papers on algorithms
- Solving PDEs and IDEs via PINN: SIAM Rev.
- Solving fPDEs via fPINN: SIAM J. Sci. Comput.
- Solving stochastic PDEs via NN-arbitrary polynomial chaos (NN-aPC): J. Comput. Phys.
- Solving inverse design/topology optimization: arXiv
- Learning from multi-fidelity data via MFNN: PNAS
- Learning nonlinear operators via DeepONet: Nat. Mach. Intell.
DeepXDE supports
- complex domain geometries without tyranny mesh generation. The primitive geometries are interval, triangle, rectangle, polygon, disk, cuboid, and sphere. Other geometries can be constructed as constructive solid geometry (CSG) using three boolean operations: union, difference, and intersection;
- 6 sampling methods: uniform, pseudorandom, Latin hypercube sampling, Halton sequence, Hammersley sequence, and Sobol sequence;
- multi-physics, i.e., coupled PDEs;
- 5 types of boundary conditions (BCs): Dirichlet, Neumann, Robin, periodic, and a general BC; BCs can be defined on an arbitrary domain or on a point set;
- time-dependent PDEs are solved as easily as time-independent ones by only adding initial conditions;
- residual-based adaptive refinement (RAR);
- uncertainty quantification using dropout;
- two types of neural networks: (stacked/unstacked) fully connected neural network, and residual neural network;
- many different losses, metrics, optimizers, learning rate schedules, initializations, regularizations, etc.;
- useful techniques, such as dropout and batch normalization;
- callbacks to monitor the internal states and statistics of the model during training;
- enables the user code to be compact, resembling closely the mathematical formulation.
All the components of DeepXDE are loosely coupled, and thus DeepXDE is well-structured and highly configurable. It is easy to customize DeepXDE to meet new demands.
DeepXDE requires TensorFlow to be installed. Then, you can install DeepXDE itself.
- Install the stable version with
pip:
$ pip install deepxde
- Install the stable version with
conda:
$ conda install -c conda-forge deepxde
- For developers, you should clone the folder to your local machine and put it along with your project scripts.
$ git clone https://github.com/lululxvi/deepxde.git
-
Dependencies
- Demos of forward problems
- Demos of inverse problems
- More examples
- FAQ
- Research papers used DeepXDE
- API
If you use DeepXDE for academic research, you are encouraged to cite the following paper:
@article{lu2021deepxde,
author = {Lu, Lu and Meng, Xuhui and Mao, Zhiping and Karniadakis, George Em},
title = {{DeepXDE}: A deep learning library for solving differential equations},
journal = {SIAM Review},
volume = {63},
number = {1},
pages = {208-228},
year = {2021},
doi = {10.1137/19M1274067}
}
First off, thanks for taking the time to contribute!
- Reporting bugs. To report a bug, simply open an issue in the GitHub "Issues" section.
- Suggesting enhancements. To submit an enhancement suggestion for DeepXDE, including completely new features and minor improvements to existing functionality, let us know by opening an issue.
- Pull requests. If you made improvements to DeepXDE, fixed a bug, or had a new example, feel free to send us a pull-request.
- Asking questions. To get help on how to use DeepXDE or its functionalities, you can as well open an issue.
- Answering questions. If you know the answer to any question in the "Issues", you are welcomed to answer.
DeepXDE was originally developed by Lu Lu at the CRUNCH group under the supervision of Prof. George Karniadakis, supported by PhILMs.
DeepXDE is currently maintained by Lu Lu with major contributions coming from several talented individuals in various forms and means. A non-exhaustive but growing list needs to mention: Shunyuan Mao, Qi Tang.