initiate jax.extend via docs and top-level module set-up

This commit is contained in:
Roy Frostig 2023-05-15 13:52:28 -07:00
parent 8b9e6bcbd4
commit ca008f37e3
4 changed files with 36 additions and 1 deletions

View File

@ -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.
These lists are not exhaustive.

4
docs/jax.extend.rst Normal file
View File

@ -0,0 +1,4 @@
``jax.extend`` module
=====================
.. automodule:: jax.extend

View File

@ -26,6 +26,7 @@ Subpackages
jax.stages
jax.tree_util
jax.typing
jax.extend
jax.example_libraries
jax.experimental

29
jax/extend/__init__.py Normal file
View File

@ -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 <https://jax.readthedocs.io/en/latest/jep/15856-jex.html>`_.
API policy
----------
Unlike the
`public API <https://jax.readthedocs.io/en/latest/api_compatibility.html>`_,
this package offers **no compatibility guarantee** across releases.
Breaking changes will be announced via the
`JAX project changelog <https://jax.readthedocs.io/en/latest/changelog.html>`_.
"""