jax.tree_util 模块

用于处理树状容器数据结构的实用工具。

此模块提供了一小组实用函数，用于处理树状数据结构，例如嵌套元组、列表和字典。我们将这些结构称为 pytrees。它们是树状结构，因为它们是递归定义的（任何非 pytree 都是 pytree，即叶子，并且任何 pytree 的 pytree 都是 pytree），并且可以递归操作（对象标识等价性不会被映射操作保留，并且结构不能包含引用循环）。

被视为 pytree 节点（例如，可以映射而不是视为叶子）的 Python 类型集是可扩展的。有一个模块级类型注册表，并且忽略类层次结构。通过注册新的 pytree 节点类型，该类型实际上对该文件中的实用函数变得透明。

此模块的主要目的是实现用户定义的数据结构与 JAX 转换（例如 jit）之间的互操作性。这并非旨在成为通用的树状数据结构处理库。

有关示例，请参阅 JAX pytrees 注释。

函数列表

Partial(func, *args, **kw)	functools.partial 的一个版本，可在 pytrees 中使用。
all_leaves(iterable[, is_leaf])	测试给定可迭代对象中的所有元素是否都是叶子。
build_tree(treedef, xs)	从嵌套的可迭代结构构建 treedef
register_dataclass(nodetype[, data_fields, ...])	扩展 pytrees 中被视为内部节点的类型集。
register_pytree_node(nodetype, flatten_func, ...)	扩展 pytrees 中被视为内部节点的类型集。
register_pytree_node_class(cls)	扩展 pytrees 中被视为内部节点的类型集。
register_pytree_with_keys(nodetype, ...[, ...])	扩展 pytrees 中被视为内部节点的类型集。
register_pytree_with_keys_class(cls)	扩展 pytrees 中被视为内部节点的类型集。
register_static(cls)	将 cls 注册为没有叶子的 pytree。
tree_flatten_with_path(tree[, is_leaf])	别名：jax.tree.flatten_with_path()。
tree_leaves_with_path(tree[, is_leaf])	别名：jax.tree.leaves_with_path()。
tree_map_with_path(f, tree, *rest[, is_leaf])	别名：jax.tree.map_with_path()。
treedef_children(treedef)	返回直接子级的 treedef 列表
treedef_is_leaf(treedef)	如果 treedef 表示叶子，则返回 True。
treedef_tuple(treedefs)	从子 treedef 的可迭代对象创建元组 treedef。
KeyEntry	类型变量。
KeyPath	别名：tuple[KeyEntry, ...]
keystr(keys, *[, simple, separator])	用于漂亮打印键元组的助手。

旧版 API

这些 API 现在通过 jax.tree 访问。

tree_all(tree, *[, is_leaf])	别名：jax.tree.all()。
tree_flatten(tree[, is_leaf])	别名：jax.tree.flatten()。
tree_leaves(tree[, is_leaf])	别名：jax.tree.leaves()。
tree_map(f, tree, *rest[, is_leaf])	别名：jax.tree.map()。
tree_reduce(function, tree[, initializer, ...])	别名：jax.tree.reduce()。
tree_structure(tree[, is_leaf])	别名：jax.tree.structure()。
tree_transpose(outer_treedef, inner_treedef, ...)	别名：jax.tree.transpose()。
tree_unflatten(treedef, leaves)	别名：jax.tree.unflatten()。