jax.tree_util.tree_map_with_path

jax.tree_util.tree_map_with_path#

jax.tree_util.tree_map_with_path(f, tree, *rest, is_leaf=None)[source]#

将一个多输入函数映射到 pytree 键路径和参数上,以生成一个新的 pytree。

这是一种比 tree_map 更强大的替代方案,它还可以将每个叶子的键路径作为输入参数。

参数:
  • f (Callable[..., Any]) – 函数接收 2 + len(rest) 个参数,即键路径和 pytree 对应叶子的每个值。

  • tree (Any) – 要映射的 pytree,每个叶子的键路径作为第一个位置参数,叶子本身作为 f 的第二个参数。

  • *rest (Any) – 一个 pytree 元组,每个 pytree 的结构与 tree 相同,或者以 tree 作为前缀。

  • is_leaf (Callable[[Any], bool] | None | None)

返回值:

一个新的 pytree,其结构与 tree 相同,但每个叶节点的值由 f(kp, x, *xs) 给出,其中 kptree 中对应叶节点的关键路径,x 是叶节点的值,而 xsrest 中对应节点的值的元组。

返回类型:

任意