Skip to content
This repository was archived by the owner on Nov 7, 2024. It is now read-only.

Commit 1e55a6a

Browse files
authored
fix doc (#598)
1 parent 1a82d4c commit 1e55a6a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

tensornetwork/backends/jax/jax_backend.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -289,17 +289,17 @@ def A(H,x):
289289
num_krylov_vecs: The number of iterations (number of krylov vectors).
290290
numeig: The nummber of eigenvector-eigenvalue pairs to be computed.
291291
If `numeig > 1`, `reorthogonalize` has to be `True`.
292-
tol: The desired precision of the eigenvalus. Uses
293-
`np.linalg.norm(eigvalsnew[0:numeig] - eigvalsold[0:numeig]) < tol`
294-
as stopping criterion between two diagonalization steps of the
295-
tridiagonal operator.
292+
tol: The desired precision of the eigenvalues. For the jax backend
293+
this has currently no effect, and precision of eigenvalues is not
294+
guaranteed. This feature may be added at a later point.
296295
delta: Stopping criterion for Lanczos iteration.
297296
If a Krylov vector :math: `x_n` has an L2 norm
298297
:math:`\\lVert x_n\\rVert < delta`, the iteration
299298
is stopped. It means that an (approximate) invariant subspace has
300299
been found.
301300
ndiag: The tridiagonal Operator is diagonalized every `ndiag` iterations
302-
to check convergence.
301+
to check convergence. This has currently no effect for the jax backend,
302+
but may be added at a later point.
303303
reorthogonalize: If `True`, Krylov vectors are kept orthogonal by
304304
explicit orthogonalization (more costly than `reorthogonalize=False`)
305305
Returns:

0 commit comments

Comments
 (0)