Merge pull request #625 from mrava87/doc-pytensor

doc: add pytensor to doc and warning about osx error
PyLops · Dec 11, 2024 · 0f526c1 · 0f526c1
2 parents 893ab69 + 8971c22
commit 0f526c1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -28,6 +28,7 @@ Templates
     LinearOperator
     FunctionOperator
     MemoizeOperator
+    PyTensorOperator
     TorchOperator
     JaxOperator
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -456,6 +456,10 @@ or via ``pip`` with
 .. note::
    PyTensor does not support NumPy 2 yet, so make sure you use NumPy 1.x with PyTensor and PyMC.
 
+.. note::
+   OSX users may experience a ``CompileError`` error when using PyTensor. This can be solved by adding 
+   ``pytensor.config.gcc__cxxflags = "-Wno-c++11-narrowing"`` after ``import pytensor``.
+
 PyWavelets
 ----------
 `PyWavelets <https://pywavelets.readthedocs.io/en/latest/>`_ is used to implement the wavelet operators.