rocm_jax/docs/jax.rst
Stephan Hoyer 877053d8ab
Add jax.linear_transpose (#3398)
* Add jax.linear_transpose

Co-authored-by: Matthew Johnson <mattjj@google.com>

* add failing test for complex numbers

* Add picky dtype check for linear_transpose

* Lint fix

* Allow truncating dtypes to match inputs in linear_transpose

* Fix typo in shape check error

* improve docstring

* Don't support integer inputs; better docstring

* fixup

* Fix doctest

Co-authored-by: Matthew Johnson <mattjj@google.com>
2020-09-16 20:29:19 -07:00

109 lines
1.8 KiB
ReStructuredText

.. currentmodule:: jax
Public API: jax package
=======================
Subpackages
-----------
.. toctree::
:maxdepth: 1
jax.numpy
jax.scipy
jax.experimental
jax.image
jax.lax
jax.nn
jax.ops
jax.random
jax.tree_util
jax.flatten_util
jax.dlpack
jax.profiler
Just-in-time compilation (:code:`jit`)
--------------------------------------
.. autosummary::
jit
disable_jit
xla_computation
make_jaxpr
eval_shape
device_put
Automatic differentiation
-------------------------
.. autosummary::
grad
value_and_grad
jacfwd
jacrev
hessian
jvp
linearize
linear_transpose
vjp
custom_jvp
custom_vjp
checkpoint
Vectorization (:code:`vmap`)
----------------------------
.. autosummary::
vmap
jax.numpy.vectorize
Parallelization (:code:`pmap`)
------------------------------
.. autosummary::
pmap
devices
local_devices
host_id
host_ids
device_count
local_device_count
host_count
.. autofunction:: jit
.. autofunction:: disable_jit
.. autofunction:: xla_computation
.. autofunction:: make_jaxpr
.. autofunction:: eval_shape
.. autofunction:: device_put
.. autofunction:: grad
.. autofunction:: value_and_grad
.. autofunction:: jacfwd
.. autofunction:: jacrev
.. autofunction:: hessian
.. autofunction:: jvp
.. autofunction:: linearize
.. autofunction:: vjp
.. autofunction:: custom_jvp
.. autofunction:: custom_vjp
.. autofunction:: checkpoint
.. autofunction:: vmap
.. autofunction:: jax.numpy.vectorize
.. autofunction:: pmap
.. autofunction:: devices
.. autofunction:: local_devices
.. autofunction:: host_id
.. autofunction:: host_ids
.. autofunction:: device_count
.. autofunction:: local_device_count
.. autofunction:: host_count