braintools.tree.take#
- braintools.tree.take(tree, idx, axis, is_leaf=<function is_quantity>)[source]#
Take elements from every leaf of a PyTree along a given axis.
- Parameters:
tree (
Quantity]) – Input PyTree.idx (
int|slice|Array|ndarray|bool|number|bool|float|complex|Quantity) – Indices used for selection. If a slice, it is applied by standard indexing; otherwiseu.math.takeis used per leaf.axis (
int) – Axis along which to take values.is_leaf (
Callable[[Any],bool] |None) – Predicate to treat a node as a leaf during traversal. Defaults to u.math.is_quantity.
- Returns:
PyTree with elements selected along axis.
- Return type:
PyTree
Examples
>>> import jax.numpy as jnp >>> import braintools >>> tree = {'m': jnp.array([[0.0, 1.0, 2.0], [3.0, 4.0, 5.0]])} >>> braintools.tree.take(tree, jnp.array([0, 2]), axis=1)['m'].tolist() [[0.0, 2.0], [3.0, 5.0]] >>> >>> braintools.tree.take(tree, slice(1, None), axis=1)['m'].tolist() [[1.0, 2.0], [4.0, 5.0]]