diff --git a/docs/api_compatibility.md b/docs/api_compatibility.md index 673129ece..68a9622cb 100644 --- a/docs/api_compatibility.md +++ b/docs/api_compatibility.md @@ -51,6 +51,7 @@ prefixed with underscores, although we do not entirely comply with this yet. * `jax.interpreters` * `jax.experimental` * `jax.example_libraries` +* `jax.extend` (see [details](https://jax.readthedocs.io/en/latest/jax.extend.html)) -These lists are not exhaustive. \ No newline at end of file +These lists are not exhaustive. diff --git a/docs/jax.extend.rst b/docs/jax.extend.rst new file mode 100644 index 000000000..1882d9a85 --- /dev/null +++ b/docs/jax.extend.rst @@ -0,0 +1,4 @@ +``jax.extend`` module +===================== + +.. automodule:: jax.extend diff --git a/docs/jax.rst b/docs/jax.rst index 78daf7b37..278b44d3d 100644 --- a/docs/jax.rst +++ b/docs/jax.rst @@ -26,6 +26,7 @@ Subpackages jax.stages jax.tree_util jax.typing + jax.extend jax.example_libraries jax.experimental diff --git a/jax/extend/__init__.py b/jax/extend/__init__.py new file mode 100644 index 000000000..e5e935d6c --- /dev/null +++ b/jax/extend/__init__.py @@ -0,0 +1,29 @@ +# Copyright 2023 The JAX Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Modules for JAX extensions. + +The :mod:`jax.extend` package provides modules for access to JAX +internal machinery. See +`JEP #15856 `_. + +API policy +---------- + +Unlike the +`public API `_, +this package offers **no compatibility guarantee** across releases. +Breaking changes will be announced via the +`JAX project changelog `_. +"""