braintools.tree.concat#
- braintools.tree.concat(trees, axis=0, is_leaf=<function is_quantity>)[source]#
Concatenate corresponding leaves from a sequence of PyTrees.
- Parameters:
- Returns:
PyTree with each leaf given by
concatenate([t[i] for t in trees], axis=axis).- Return type:
PyTree
Notes
All PyTrees in trees must share the same PyTree structure, and their corresponding leaves must be compatible for concatenation along axis.
Examples
>>> import jax.numpy as jnp >>> import braintools >>> tree = {'a': jnp.array([1.0, 2.0]), 'b': jnp.array([3.0])} >>> other = {'a': jnp.array([10.0, 20.0]), 'b': jnp.array([30.0])} >>> out = braintools.tree.concat([tree, other]) >>> {k: v.tolist() for k, v in out.items()} {'a': [1.0, 2.0, 10.0, 20.0], 'b': [3.0, 30.0]}