braintools.tree.sum#
- braintools.tree.sum(tree, is_leaf=<function is_quantity>)[source]#
Sum all elements across every leaf in a PyTree.
- Parameters:
- Returns:
Scalar sum across all leaves and their elements.
- Return type:
Array
See also
dotInner product across leaves.
squared_normSum of squares across leaves.
Examples
>>> import jax.numpy as jnp >>> import braintools >>> tree = {'a': jnp.array([1.0, 2.0]), 'b': jnp.array([3.0])} >>> float(braintools.tree.sum(tree)) 6.0