Skip to content

Commit 9369027

Browse files
committed
Add note about healpy wrapper gradient behaviour
1 parent cedf1f5 commit 9369027

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

s2fft/transforms/spherical.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -384,8 +384,11 @@ def forward(
384384
Primarily of use with HEALPix sampling for which there is not a sampling
385385
theorem, and round-tripping through the forward and inverse transforms will
386386
introduce an error. If set to `None`, the default, 3 iterations will be used
387-
if :code:`sampling == "healpix"` and :code`method == "jax_healpy"` and zero
388-
otherwise. Not used for `jax_ssht` method.
387+
if :code:`sampling == "healpix"` and :code:`method == "jax_healpy"` and zero
388+
otherwise. For the `healpy` wrappers specifically (that is when
389+
:code:`method == "jax_healpy"`) increasing the number iterations increases
390+
the accuracy of the forward transform, but reduce the accuracy of the
391+
gradient pass. Not used for `jax_ssht` method.
389392
390393
_ssht_backend (int, optional, experimental): Whether to default to SSHT core
391394
(set to 0) recursions or pick up ducc0 (set to 1) accelerated experimental

0 commit comments

Comments
 (0)