Skip to content

Commit

Permalink
[doc] Add links to Φ-ML
Browse files Browse the repository at this point in the history
  • Loading branch information
holl- committed Oct 12, 2023
1 parent d7c8a8d commit 8262f60
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 4 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ This will check for compatible PyTorch, Jax and TensorFlow installations as well
   [**Demos**](https://github.com/tum-pbs/PhiFlow/tree/master/demos)
&nbsp;&nbsp; [<img src="https://www.tensorflow.org/images/colab_logo_32px.png" height=16> **Playground**](https://colab.research.google.com/drive/1zBlQbmNguRt-Vt332YvdTqlV4DBcus2S#offline=true&sandboxMode=true)

Φ-Flow builds on the tensor functionality from [Φ<sub>ML</sub>](https://github.com/tum-pbs/PhiML).
To understand how Φ<sub>Flow</sub> works, check [named and typed dimensions](https://tum-pbs.github.io/PhiML/Introduction.html) first.

To get started, check out our YouTube tutorial series and the following Jupyter notebooks:

* [<img src="https://www.tensorflow.org/images/colab_logo_32px.png" height=16>](https://colab.research.google.com/github/tum-pbs/PhiFlow/blob/develop/docs/Math_Introduction.ipynb) [Tensors](https://tum-pbs.github.io/PhiFlow/Math_Introduction.html): Introduction to tensors.
Expand Down
5 changes: 4 additions & 1 deletion phi/math/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
"""
Alias for `phiml.math`.
Alias for [`phiml.math`](https://tum-pbs.github.io/PhiML/phiml/math/index.html).
Φ-Flow builds on the tensor functionality from [Φ-ML](https://github.com/tum-pbs/PhiML).
Its `math` package is re-imported here for convenience.
"""
from phiml.math import *

Expand Down
2 changes: 1 addition & 1 deletion phi/math/backend.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
Alias for `phiml.backend`.
Alias for [`phiml.backend`](https://tum-pbs.github.io/PhiML/phiml/backend/index.html).
"""
from phiml.backend import *
2 changes: 1 addition & 1 deletion phi/math/extrapolation.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
Alias for `phiml.math.extrapolation`
Alias for [`phiml.math.extrapolation`](https://tum-pbs.github.io/PhiML/phiml/math/extrapolation.html).
"""
from phiml.math.extrapolation import *
2 changes: 1 addition & 1 deletion phi/math/magic.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""
Alias for `phiml.math.magic`
Alias for [`phiml.math.magic`](https://tum-pbs.github.io/PhiML/phiml/math/magic.html).
"""
from phiml.math.magic import *

0 comments on commit 8262f60

Please sign in to comment.