Skip to content

Latest commit

 

History

History
129 lines (94 loc) · 8.06 KB

README.md

File metadata and controls

129 lines (94 loc) · 8.06 KB
Raw

DeepXDE

Build Status Documentation Status Codacy Badge PyPI Version PyPI Downloads Conda Version Conda Downloads License

DeepXDE is a library for scientific machine learning. 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 nonlinear operators via deep operator network (DeepONet),
  • approximates functions from multi-fidelity data via multi-fidelity NN (MFNN),
  • approximates functions from a dataset with/without constraints.

DeepXDE supports three tensor libraries as backends: TensorFlow 1.x (tensorflow.compat.v1 in TensorFlow 2.x), TensorFlow 2.x, and PyTorch. For how to select one, see Working with different backends.

Documentation: ReadTheDocs, SIAM Rev., Slides, Video

Papers on algorithms

Features

DeepXDE has implemented many algorithms as shown above and supports many features:

  • 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.
  • multi-physics, i.e., (time-dependent) coupled PDEs.
  • 5 types of boundary conditions (BCs): Dirichlet, Neumann, Robin, periodic, and a general BC, which can be defined on an arbitrary domain or on a point set.
  • different neural networks, such as (stacked/unstacked) fully connected neural network, residual neural network, and (spatio-temporal) multi-scale fourier feature networks.
  • 6 sampling methods: uniform, pseudorandom, Latin hypercube sampling, Halton sequence, Hammersley sequence, and Sobol sequence. The training points can keep the same during training or be resampled every certain iterations.
  • conveniently save the model during training, and load a trained model.
  • uncertainty quantification using dropout.
  • many different (weighted) losses, optimizers, learning rate schedules, metrics, etc.
  • callbacks to monitor the internal states and statistics of the model during training, such as early stopping.
  • 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.

Installation

DeepXDE requires TensorFlow or PyTorch 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

Explore more

Cite DeepXDE

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}
}

Also, if you would like your paper to appear here, open an issue in the GitHub "Issues" section.

Contributing to DeepXDE

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.

The Team

DeepXDE was originally developed by Lu Lu at Brown University under the supervision of Prof. George Karniadakis, supported by PhILMs.

DeepXDE is currently maintained by Lu Lu at University of Pennsylvania with major contributions coming from several talented individuals in various forms and means. A non-exhaustive but growing list needs to mention: Shunyuan Mao, Zongren Zou.

License

Apache license 2.0