jax.tree_util.register_pytree_node_class

jax.tree_util.register_pytree_node_class(cls)

扩展被视为 pytrees 内部节点的类型集。

此函数是对 register_pytree_node 的薄包装，并提供面向类的接口。

参数:

cls (Typ) – 要注册为 pytree 的类型

返回:

输入类 cls 在被添加到 JAX 的 pytree 注册表中后保持不变。此返回值允许 register_pytree_node_class 用作装饰器。

返回类型:

类型

另请参阅

• register_static()：注册静态 pytree 的简化 API。

• register_dataclass()：注册 dataclass 的简化 API。

• register_pytree_node()

• register_pytree_with_keys()

• register_pytree_with_keys_class()

示例

在这里，我们将定义一个自定义容器，它将与 jax.jit() 和其他 JAX 转换兼容

>>> import jax
>>> @jax.tree_util.register_pytree_node_class
... class MyContainer:
...   def __init__(self, x, y):
...     self.x = x
...     self.y = y
...   def tree_flatten(self):
...     return ((self.x, self.y), None)
...   @classmethod
...   def tree_unflatten(cls, aux_data, children):
...     return cls(*children)
...
>>> m = MyContainer(jnp.zeros(4), jnp.arange(4))
>>> def f(m):
...   return m.x + 2 * m.y
>>> jax.jit(f)(m)
Array([0., 2., 4., 6.], dtype=float32)