rocm_jax/docs/concurrency.rst
Stephan Hoyer c3bf532aae Fix sphinx references in JAX docs
The links in `concurrency.rst` should work now.

The links in async_dispatch.rst don't work yet, but they will if
``DeviceArray`` ever ends up JAX's API docs.
2019-08-10 16:40:08 -07:00

18 lines
700 B
ReStructuredText

Concurrency
===========
JAX has some limited support for Python concurrency.
Concurrency support is experimental and only lightly tested; please report any
bugs.
Clients may call JAX APIs (e.g., :func:`~jax.jit` or :func:`~jax.grad`)
concurrently from separate Python threads.
It is not permitted to manipulate JAX trace values concurrently from multiple
threads. In other words, while it is permissible to call functions that use JAX
tracing (e.g., :func:`~jax.jit`) from multiple threads, you must not use
threading to manipulate JAX values inside the implementation of the function
`f` that is passed to :func:`~jax.jit`. The most likely outcome if you do this
is a mysterious error from JAX.