Skip to content

Commit

Permalink
Add warning about API instability.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 630395902
  • Loading branch information
danieldjohnson authored and Penzai Developers committed May 3, 2024
1 parent b3777d7 commit 4aa2d7e
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,19 @@ each useable independently:
Documentation on Penzai can be found at
[https://penzai.readthedocs.io](https://penzai.readthedocs.io).

> [!WARNING]
> Penzai's API is currently unstable and may change in future releases.
>
> In particular, the way Penzai handles parameter initialization, parameter
> sharing, and local mutable state in `penzai.nn` and
> `penzai.data_effects` is likely to be simplified in the future.
> Some internal details of the `treescope` pretty-printer intermediate
> representation may also change to make it easier to extend and configure.
>
> Projects that use Penzai's neural network components or model implementations,
> or that define their own handlers for `treescope`, are encouraged to pin the
> `0.1.x` release series (e.g. `penzai>=0.1,<0.2`) to avoid breaking changes.

## Getting Started

Expand Down
14 changes: 14 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,20 @@ useable independently:
These components are described in more detail in the guides in the left
sidebar.

.. warning::
Penzai's API is currently unstable and may change in future releases.

In particular, the way Penzai handles parameter initialization, parameter
sharing, and local mutable state in `penzai.nn` and
`penzai.data_effects` is likely to be simplified in the future.
Some internal details of the `penzai.treescope` pretty-printer intermediate
representation may also change to make it easier to extend and configure.

Projects that use Penzai's neural network components or model
implementations, or that define their own handlers for ``treescope``, are
encouraged to pin the ``0.1.x`` release series (e.g. ``penzai>=0.1,<0.2``)
to avoid breaking changes.

Getting Started
---------------

Expand Down

0 comments on commit 4aa2d7e

Please sign in to comment.