Skip to content

Commit 4a25812

Browse files
committed
Update docs
1 parent 7733faa commit 4a25812

File tree

3 files changed

+38
-19
lines changed

3 files changed

+38
-19
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ First off, thanks for taking the time to contribute!
143143

144144
DeepXDE was developed by [Lu Lu](https://lu.seas.upenn.edu) under the supervision of Prof. [George Karniadakis](https://www.brown.edu/research/projects/crunch/george-karniadakis) at [Brown University](https://www.brown.edu) from the summer of 2018 to 2020, supported by [PhILMs](https://www.pnnl.gov/computing/philms). DeepXDE was originally self-hosted in Subversion at Brown University, under the name SciCoNet (Scientific Computing Neural Networks). On Feb 7, 2019, SciCoNet was moved from Subversion to GitHub, renamed to DeepXDE.
145145

146-
DeepXDE is currently maintained by [Lu Lu](https://lu.seas.upenn.edu) at [University of Pennsylvania](https://www.upenn.edu) with major contributions coming from several talented individuals in various forms and means. A non-exhaustive but growing list needs to mention: [Shunyuan Mao](https://github.com/smao-astro), [Zongren Zou](https://github.com/ZongrenZou).
146+
DeepXDE is currently maintained by [Lu Lu](https://lu.seas.upenn.edu) at [University of Pennsylvania](https://www.upenn.edu) with major contributions coming from several talented individuals in various forms and means. A non-exhaustive but growing list needs to mention: [Zongren Zou](https://github.com/ZongrenZou), [Shunyuan Mao](https://github.com/smao-astro).
147147

148148
## License
149149

docs/user/faq.rst

Lines changed: 36 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ FAQ
33

44
If you have any questions about DeepXDE, first read the papers/slides and watch the video at the `DeepXDE homepage <https://deepxde.readthedocs.io>`_ and also check the following list of frequently asked DeepXDE questions. To get further help, you can open an issue in the GitHub "Issues" section.
55

6-
Usage of DeepXDE
7-
----------------
6+
General usage
7+
-------------
88

99
- | **Q**: DeepXDE failed to run.
1010
| **A**: `#2`_, `#3`_, `#5`_
@@ -17,7 +17,7 @@ Usage of DeepXDE
1717
- | **Q**: How can I use a trained model for new predictions?
1818
| **A**: `#10`_, `#18`_, `#93`_, `#177`_
1919
- | **Q**: How can I save a trained model and then load the model later?
20-
| **A**: `#54`_, `#57`_, `#58`_, `#63`_, `#103`_, `#206`_, `#254`_
20+
| **A**: `#54`_, `#57`_, `#58`_, `#63`_, `#103`_, `#206`_, `#254`_, `#468`_
2121
- | **Q**: More details about DeepXDE source code, and want to modify DeepXDE.
2222
| **A**: `#68`_, `#346`_
2323
@@ -28,47 +28,55 @@ PINN
2828
| **A**: `#4`_, `#9`_, `#17`_, `#48`_, `#53`_, `#73`_, `#77`_, `#171`_, `#217`_, `#218`_, `#223`_, `#274`_, `#276`_
2929
- | **Q**: More details and examples about geometry.
3030
| **A**: `#32`_, `#38`_, `#161`_, `#264`_, `#278`_, `#332`_
31-
- | **Q**: How can I implement new ODEs/PDEs, e.g., compute derivatives, complicated PDEs?
32-
| **A**: `#12`_, `#13`_, `#21`_, `#22`_, `#74`_, `#78`_, `#79`_, `#124`_, `#172`_, `#185`_, `#193`_, `#194`_, `#246`_, `#302`_, `#377`_, `#421`_, `#451`_, `#465`_
31+
- | **Q**: How can I implement new ODEs/PDEs, e.g., compute derivatives, complicated PDEs, complicated coefficients?
32+
| **A**: `#12`_, `#13`_, `#21`_, `#22`_, `#74`_, `#78`_, `#79`_, `#124`_, `#172`_, `#185`_, `#193`_, `#194`_, `#246`_, `#302`_, `#377`_, `#421`_, `#451`_, `#465`_, `#478`_, `#480`_
3333
- | **Q**: More details and examples about initial conditions.
34-
| **A**: `#19`_, `#75`_, `#104`_, `#134`_, `#398`_
34+
| **A**: `#19`_, `#75`_, `#104`_, `#134`_, `#398`_, `#485`_
3535
- | **Q**: More details and examples about boundary conditions.
36-
| **A**: `#6`_, `#10`_, `#15`_, `#16`_, `#22`_, `#26`_, `#33`_, `#38`_, `#40`_, `#44`_, `#49`_, `#115`_, `#140`_, `#156`_, `#352`_, `#365`_, `#457`_
36+
| **A**: `#6`_, `#10`_, `#15`_, `#16`_, `#22`_, `#26`_, `#33`_, `#38`_, `#40`_, `#44`_, `#49`_, `#115`_, `#140`_, `#156`_, `#352`_, `#365`_, `#457`_, `#475`_
3737
- | **Q**: By default, initial/boundary conditions are enforced in DeepXDE as soft constraints. How can I enforce them as hard constraints?
3838
| **A**: `#36`_, `#90`_, `#92`_, `#252`_
3939
- | **Q**: How can I use a dataset of the solution?
40-
| **A**: `#362`_
40+
| **A**: `#362`_, `#487`_
4141
- | **Q**: I failed to train the network or get the right solution, e.g., large training loss, unbalanced losses.
4242
| **A**: `#15`_, `#22`_, `#33`_, `#41`_, `#61`_, `#62`_, `#80`_, `#84`_, `#85`_, `#108`_, `#126`_, `#141`_, `#188`_, `#247`_, `#305`_, `#321`_
4343
- | **Q**: L-BFGS.
4444
| **A**: `#364`_, `#395`_
4545
- | **Q**: Implement certain features for the input, such as Fourier features.
46-
| **A**: `#277`_
46+
| **A**: `#277`_, `#477`_
4747
- | **Q**: A standard network doesn't work for me, and I want to implement a network with a special structure/property.
48-
| **A**: `#355`_, `#363`_
48+
| **A**: `#355`_, `#363`_, `#466`_
4949
- | **Q**: Implement new losses or constraints.
50-
| **A**: `#286`_, `#311`_, `#356`_, `#460`_
50+
| **A**: `#174`_, `#286`_, `#311`_, `#356`_, `#460`_, `#467`_, `#504`_
5151
- | **Q**: How can I implement new IDEs?
5252
| **A**: `#95`_, `#198`_
5353
- | **Q**: Solve PDEs with complex numbers.
5454
| **A**: `#284`_
5555
- | **Q**: Solve inverse problems with unknown parameters/fields in the PDEs or initial/boundary conditions.
5656
| **A**: `#55`_, `#76`_, `#86`_, `#114`_, `#120`_, `#125`_, `#178`_, `#208`_, `#235`_, `#380`_
5757
- | **Q**: Solve parametric PDEs.
58-
| **A**: `#273`_, `#299`_, `#379`_
58+
| **A**: `#273`_, `#299`_, `#379`_, `#482`_
5959
- | **Q**: How does DeepXDE choose the training points? How can I use some specific training points?
60-
| **A**: `#32`_, `#57`_, `#64`_
60+
| **A**: `#32`_, `#57`_, `#64`_, `#345`_
6161
- | **Q**: How can I give different weights to different residual points?
6262
| **A**: `#45`_
6363
- | **Q**: Residual-based adaptive refinement (RAR).
6464
| **A**: `#63`_
6565
- | **Q**: I want to customize network training/optimization, e.g., mini-batch.
6666
| **A**: `#166`_, `#307`_, `#320`_, `#331`_
67+
- | **Q**: I want to get more information about the network, such as the values and gradients of hidden layers.
68+
| **A**: `#149`_, `#490`_
6769
- | **Q**: More details about DeepXDE source code, or I want to modify DeepXDE.
6870
| **A**: `#35`_, `#39`_, `#66`_, `#69`_, `#91`_, `#99`_, `#131`_, `#163`_, `#175`_, `#202`_, `#357`_
6971
- | **Q**: Examples collected from users.
7072
| **A**: `Lotka–Volterra <https://github.com/lululxvi/deepxde/issues/85>`_, `Potential flow around a cylinder <https://github.com/lululxvi/deepxde/issues/49>`_, `Laminar Incompressible flow passing a step <https://github.com/lululxvi/deepxde/issues/80>`_, `Shallow water equations <https://github.com/lululxvi/deepxde/issues/247>`_, `2D time-dependent heat equation <https://github.com/lululxvi/deepxde/issues/61>`_
7173
74+
DeepONet
75+
--------
76+
77+
- | **Q**:
78+
| **A**:
79+
7280
Multi-fidelity NN
7381
-----------------
7482

@@ -152,12 +160,14 @@ Multi-fidelity NN
152160
.. _#134: https://github.com/lululxvi/deepxde/issues/134
153161
.. _#140: https://github.com/lululxvi/deepxde/issues/140
154162
.. _#141: https://github.com/lululxvi/deepxde/issues/141
163+
.. _#149: https://github.com/lululxvi/deepxde/issues/149
155164
.. _#156: https://github.com/lululxvi/deepxde/issues/156
156165
.. _#161: https://github.com/lululxvi/deepxde/issues/161
157166
.. _#163: https://github.com/lululxvi/deepxde/issues/163
158167
.. _#166: https://github.com/lululxvi/deepxde/issues/166
159168
.. _#171: https://github.com/lululxvi/deepxde/issues/171
160169
.. _#172: https://github.com/lululxvi/deepxde/issues/172
170+
.. _#174: https://github.com/lululxvi/deepxde/issues/174
161171
.. _#175: https://github.com/lululxvi/deepxde/issues/175
162172
.. _#177: https://github.com/lululxvi/deepxde/issues/177
163173
.. _#178: https://github.com/lululxvi/deepxde/issues/178
@@ -196,6 +206,7 @@ Multi-fidelity NN
196206
.. _#324: https://github.com/lululxvi/deepxde/issues/324
197207
.. _#331: https://github.com/lululxvi/deepxde/issues/331
198208
.. _#332: https://github.com/lululxvi/deepxde/issues/332
209+
.. _#345: https://github.com/lululxvi/deepxde/issues/345
199210
.. _#346: https://github.com/lululxvi/deepxde/issues/346
200211
.. _#352: https://github.com/lululxvi/deepxde/issues/352
201212
.. _#353: https://github.com/lululxvi/deepxde/issues/353
@@ -218,7 +229,15 @@ Multi-fidelity NN
218229
.. _#460: https://github.com/lululxvi/deepxde/issues/460
219230
.. _#464: https://github.com/lululxvi/deepxde/issues/464
220231
.. _#465: https://github.com/lululxvi/deepxde/issues/465
221-
222-
.. _#149: https://github.com/lululxvi/deepxde/issues/149
223-
.. _#174: https://github.com/lululxvi/deepxde/issues/174
224-
.. _#345: https://github.com/lululxvi/deepxde/issues/345
232+
.. _#466: https://github.com/lululxvi/deepxde/issues/466
233+
.. _#467: https://github.com/lululxvi/deepxde/issues/467
234+
.. _#468: https://github.com/lululxvi/deepxde/issues/468
235+
.. _#475: https://github.com/lululxvi/deepxde/issues/475
236+
.. _#477: https://github.com/lululxvi/deepxde/issues/477
237+
.. _#478: https://github.com/lululxvi/deepxde/issues/478
238+
.. _#480: https://github.com/lululxvi/deepxde/issues/480
239+
.. _#482: https://github.com/lululxvi/deepxde/issues/482
240+
.. _#485: https://github.com/lululxvi/deepxde/issues/485
241+
.. _#487: https://github.com/lululxvi/deepxde/issues/487
242+
.. _#490: https://github.com/lululxvi/deepxde/issues/490
243+
.. _#504: https://github.com/lululxvi/deepxde/issues/504

docs/user/team.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ The Team
33

44
DeepXDE was developed by `Lu Lu <https://lu.seas.upenn.edu>`_ under the supervision of Prof. `George Karniadakis <https://www.brown.edu/research/projects/crunch/george-karniadakis>`_ at `Brown University <https://www.brown.edu>`_ from the summer of 2018 to 2020, supported by `PhILMs <https://www.pnnl.gov/computing/philms>`_. DeepXDE was originally self-hosted in Subversion at Brown University, under the name SciCoNet (Scientific Computing Neural Networks). On Feb 7, 2019, SciCoNet was moved from Subversion to GitHub, renamed to DeepXDE.
55

6-
DeepXDE is currently maintained by `Lu Lu <https://lu.seas.upenn.edu>`_ at `University of Pennsylvania <https://www.upenn.edu>`_ with major contributions coming from several talented individuals in various forms and means. A non-exhaustive but growing list needs to mention: `Shunyuan Mao <https://github.com/smao-astro>`_, `Zongren Zou <https://github.com/ZongrenZou>`_.
6+
DeepXDE is currently maintained by `Lu Lu <https://lu.seas.upenn.edu>`_ at `University of Pennsylvania <https://www.upenn.edu>`_ with major contributions coming from several talented individuals in various forms and means. A non-exhaustive but growing list needs to mention: `Zongren Zou <https://github.com/ZongrenZou>`_, `Shunyuan Mao <https://github.com/smao-astro>`_.

0 commit comments

Comments
 (0)