[pallas] Add a warning message about experimental and incomplete status

This commit is contained in:
George Necula 2024-08-07 08:38:56 +03:00
parent dd958adc39
commit 64eb8e9639

View File

@ -3,6 +3,9 @@
Pallas: a JAX kernel language
=============================
Pallas is an extension to JAX that enables writing custom kernels for GPU and TPU.
It aims to provide fine-grained control over the generated code, combined with
the high-level ergonomics of JAX tracing and the `jax.numpy` API.
This section contains tutorials, guides and examples for using Pallas.
See also the :class:`jax.experimental.pallas` module API documentation.
@ -10,6 +13,10 @@ See also the :class:`jax.experimental.pallas` module API documentation.
Pallas is experimental and is changing frequently.
See the :ref:`pallas-changelog` for the recent changes.
You can expect to encounter errors and unimplemented cases, e.g., when
lowering of high-level JAX concepts that would require emulation,
or simply because Pallas is still under development.
.. toctree::
:caption: Guides
:maxdepth: 2