Skip to content

Commit 95e13b8

Browse files
committed
Update docs
1 parent 56f4e88 commit 95e13b8

File tree

3 files changed

+7
-17
lines changed

3 files changed

+7
-17
lines changed

README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ DeepXDE is a library for scientific machine learning and physics-informed learni
3232
- multifidelity neural network (MFNN)
3333
- learning from multifidelity data [[J. Comput. Phys.](https://doi.org/10.1016/j.jcp.2019.109020), [PNAS](https://doi.org/10.1073/pnas.1922210117)]
3434

35-
DeepXDE supports four tensor libraries as backends: TensorFlow 1.x (`tensorflow.compat.v1` in TensorFlow 2.x), TensorFlow 2.x, PyTorch, and JAX (in development). For how to select one, see [Working with different backends](https://deepxde.readthedocs.io/en/latest/user/installation.html#working-with-different-backends).
35+
DeepXDE supports four tensor libraries as backends: TensorFlow 1.x (`tensorflow.compat.v1` in TensorFlow 2.x), TensorFlow 2.x, PyTorch, and JAX. For how to select one, see [Working with different backends](https://deepxde.readthedocs.io/en/latest/user/installation.html#working-with-different-backends).
3636

3737
**Documentation**: [ReadTheDocs](https://deepxde.readthedocs.io)
3838

@@ -92,14 +92,6 @@ $ conda install -c conda-forge deepxde
9292
$ git clone https://github.com/lululxvi/deepxde.git
9393
```
9494

95-
- Other dependencies
96-
97-
- [Matplotlib](https://matplotlib.org/)
98-
- [NumPy](http://www.numpy.org/)
99-
- [scikit-learn](https://scikit-learn.org)
100-
- [scikit-optimize](https://scikit-optimize.github.io)
101-
- [SciPy](https://www.scipy.org/)
102-
10395
## Explore more
10496

10597
- [Install and Setup](https://deepxde.readthedocs.io/en/latest/user/installation.html)
@@ -127,17 +119,15 @@ If you use DeepXDE for academic research, you are encouraged to cite the followi
127119
}
128120
```
129121

130-
Also, if you would like your paper to appear [here](https://deepxde.readthedocs.io/en/latest/user/research.html), open an issue in the GitHub "Issues" section.
131-
132122
## Contributing to DeepXDE
133123

134124
First off, thanks for taking the time to contribute!
135125

136-
- **Reporting bugs.** To report a bug, simply open an issue in the GitHub "Issues" section.
137-
- **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.
126+
- **Reporting bugs.** To report a bug, simply open an issue in the GitHub [Issues](https://github.com/lululxvi/deepxde/issues).
127+
- **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 in the GitHub [Issues](https://github.com/lululxvi/deepxde/issues).
138128
- **Pull requests.** If you made improvements to DeepXDE, fixed a bug, or had a new example, feel free to send us a pull-request.
139-
- **Asking questions.** To get help on how to use DeepXDE or its functionalities, you can as well open an issue.
140-
- **Answering questions.** If you know the answer to any question in the "Issues", you are welcomed to answer.
129+
- **Asking questions.** To get help on how to use DeepXDE or its functionalities, you can open a discussion in the GitHub [Discussions](https://github.com/lululxvi/deepxde/discussions).
130+
- **Answering questions.** If you know the answer to any question in the [Discussions](https://github.com/lululxvi/deepxde/discussions), you are welcomed to answer.
141131

142132
**Slack.** The DeepXDE Slack hosts a primary audience of moderate to experienced DeepXDE users and developers for general chat, online discussions, collaboration, etc. If you need a slack invite, please send me an email.
143133

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ DeepXDE
2424
- multifidelity neural network (MFNN)
2525
- learning from multifidelity data [`J. Comput. Phys. <https://doi.org/10.1016/j.jcp.2019.109020>`_, `PNAS <https://doi.org/10.1073/pnas.1922210117>`_]
2626

27-
DeepXDE supports four tensor libraries as backends: TensorFlow 1.x (``tensorflow.compat.v1`` in TensorFlow 2.x), TensorFlow 2.x, PyTorch, and JAX (in development). For how to select one, see `Working with different backends <https://deepxde.readthedocs.io/en/latest/user/installation.html#working-with-different-backends>`_.
27+
DeepXDE supports four tensor libraries as backends: TensorFlow 1.x (``tensorflow.compat.v1`` in TensorFlow 2.x), TensorFlow 2.x, PyTorch, and JAX. For how to select one, see `Working with different backends <https://deepxde.readthedocs.io/en/latest/user/installation.html#working-with-different-backends>`_.
2828

2929
**Documentation**: `ReadTheDocs <https://deepxde.readthedocs.io/>`_
3030

docs/user/faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
FAQ
22
===
33

4-
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.
4+
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 a discussion in the GitHub `Discussions <https://github.com/lululxvi/deepxde/discussions>`_.
55

66
General usage
77
-------------

0 commit comments

Comments
 (0)