Skip to content

Commit cda8547

Browse files
authored
Update docs about backend (#1287)
1 parent 4363618 commit cda8547

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/user/installation.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ DeepXDE supports TensorFlow 1.x (``tensorflow.compat.v1`` in TensorFlow 2.x), Te
5858

5959
* Use the ``DDE_BACKEND`` environment variable:
6060

61-
- You can use ``DDE_BACKEND=BACKEND python pde.py`` to specify the backend:
61+
- You can use ``DDE_BACKEND=BACKEND python pde.py`` to specify the backend. Currently ``BACKEND`` can be chosen from "tensorflow.compat.v1" (TensorFlow 1.x backend), "tensorflow" (TensorFlow 2.x backend), "pytorch" (PyTorch), "jax" (JAX), and "paddle" (PaddlePaddle).
6262

6363
$ DDE_BACKEND=tensorflow.compat.v1 python pde.py
6464

@@ -78,15 +78,15 @@ DeepXDE supports TensorFlow 1.x (``tensorflow.compat.v1`` in TensorFlow 2.x), Te
7878
- You can also use ``python -m deepxde.backend.set_default_backend BACKEND`` to set the default backend
7979
- In Windows, you can find ``config.json`` file under "C:/Users/Username/.deepxde" directory
8080

81-
Currently ``BACKEND`` can be chosen from "tensorflow.compat.v1" (TensorFlow 1.x backend), "tensorflow" (TensorFlow 2.x backend), "pytorch" (PyTorch), "jax" (JAX), and "paddle" (PaddlePaddle). The default backend is TensorFlow 1.x.
81+
* If no backend is selected as above, DeepXDE will automatically find an available backend.
8282

8383
Which backend should I choose?
8484
``````````````````````````````
8585

86-
Although TensorFlow 1.x is the default backend, it may not be your best choice. Here is a comparison between different backends:
86+
Here is a comparison between different backends:
8787

8888
- Different backends support slightly different features, and switch to another backend if DeepXDE raised a backend-related error.
89-
- Currently, the number of features supported is: TensorFlow 1.x > TensorFlow 2.x > PyTorch > JAX.
89+
- Currently, the number of features supported is: PaddlePaddle ≈ TensorFlow 1.x > TensorFlow 2.x PyTorch > JAX.
9090
- Some features can be implemented easily (basically translating from one framework to another), and we welcome your contributions.
9191
- Different backends have different computational speed, and switch to another backend if the speed is an issue in your case.
9292
- We find that there is no backend that is always faster than the others.

0 commit comments

Comments
 (0)