API 兼容性

API 兼容性#

JAX 不断发展，我们希望能够改进其 API。尽管如此，我们希望尽量减少 JAX 用户社区的动荡，并尽量避免进行重大更改。

JAX 版本控制#

JAX 使用基于努力的版本控制 (参见 JEP 25516: JAX 基于努力的版本控制)，目前处于零版本阶段。这意味着对于版本 0.X.Y，递增 Y 将引入较小的破坏性更改，而递增 X 将引入较大的破坏性更改。

对于任何破坏性更改，JAX 目前遵循 3 个月的弃用策略。当对 API 进行不兼容的更改时，我们将尽最大努力遵守以下步骤

该更改将在 CHANGELOG.md 和已弃用 API 的文档字符串中宣布，并且旧的 API 将发出 DeprecationWarning。
在弃用 API 的 jax 版本发布三个月后，我们可以随时删除已弃用的 API。请注意，三个月是下限，并且有意选择比许多更成熟的项目快。实际上，弃用可能需要相当长的时间，特别是如果某个功能有很多用户。如果三个月的弃用期出现问题，请向我们提出。

我们保留随时更改此策略的权利。

涵盖内容？#

仅涵盖公共 JAX API，其中包括以下模块

jax
jax.dlpack
jax.image
jax.lax
jax.nn
jax.numpy
jax.ops
jax.profiler
jax.random (参见下面的详细信息)
jax.scipy
jax.tree
jax.tree_util
jax.test_util

并非所有这些模块中的内容都旨在公开，随着时间的推移，我们正在努力分离公共 API 和私有 API。公共 API 在 JAX 文档中进行了记录。此外，我们的目标是所有非公共 API 都应以划线作为名称前缀，尽管我们尚未完全遵守这一点。

未涵盖内容？#

显式私有 API#

任何以划线为前缀的 API 或导入路径都是显式私有的，并且可能会在 JAX 版本之间更改，恕不另行通知。我们正在努力将所有私有 API 移动到 jax._src 中，以使这些期望更加明确。

遗留内部 API#

此外，还有几个遗留模块当前公开了一些没有划线的私有 API，包括

jax.core
jax.interpreters
jax.lib
jax.util

我们正在积极努力弃用这些模块及其包含的 API。在大多数情况下，此类弃用将遵循 3 个月的弃用期，但并非总是可行。如果您使用任何此类 API，请预计它们会很快被弃用，并寻找替代方案。

实验性和示例库#

以下模块包含用于实验或演示目的的代码，并且 API 可能会在版本之间更改，恕不另行通知

jax.experimental
jax.example_libraries

我们理解某些用户依赖 jax.experimental，因此在大多数情况下，我们对更改遵循 3 个月的弃用期，但并非总是可行。

JAX 扩展#

jax.extend 模块包含半公开的 JAX 内部 API，旨在供下游项目使用，但与主 JAX 包的稳定性保证不同。如果您的代码使用 jax.extend，我们强烈建议针对 JAX 的每日构建版本进行 CI 测试，以便在发布之前捕获潜在的更改。

有关 jax.extend 的详细信息，请参阅jax.extend 模块文档或设计文档，jax.extend：用于扩展的模块。

数值和随机性#

不能保证数值运算的确切值在 JAX 版本之间保持稳定。实际上，确切的数值不一定在给定的 JAX 版本中、跨加速器平台、在 jax.jit 内或外等等都保持稳定。

对于固定的 PRNG 密钥输入，jax.random 中伪随机函数的输出可能因 JAX 版本而异。兼容性策略仅适用于输出分布。例如，表达式 jax.random.gumbel(jax.random.key(72)) 可能在不同的 JAX 版本中返回不同的值，但 jax.random.gumbel 仍将是 Gumbel 分布的伪随机生成器。

我们尽量减少此类伪随机值的更改。当发生更改时，这些更改会在更改日志中宣布，但不遵循弃用周期。在某些情况下，JAX 可能会公开一个临时配置标志来恢复新的行为，以帮助用户诊断和更新受影响的代码。此类标志将持续一个弃用窗口的时间。