Add tree_bits function.

Author: carlosgmartin

docs/api/utilities.rst

@@ -120,6 +120,7 @@ Tree
     tree_scale
     tree_set
     tree_size
+    tree_bits
     tree_sub
     tree_sum
     tree_vdot
@@ -226,6 +227,10 @@ Tree size
 ~~~~~~~~~
 .. autofunction:: tree_size
 
+Tree bits
+~~~~~~~~~
+.. autofunction:: tree_bits
+
 Tree subtract
 ~~~~~~~~~~~~~
 .. autofunction:: tree_sub

optax/tree/__init__.py

@@ -48,6 +48,7 @@
 real = _tree_math.tree_real
 scale = _tree_math.tree_scale
 size = _tree_math.tree_size
+bits = _tree_math.tree_bits
 sub = _tree_math.tree_sub
 sum = _tree_math.tree_sum  # pylint: disable=redefined-builtin
 update_infinity_moment = _tree_math.tree_update_infinity_moment

optax/tree_utils/__init__.py

@@ -47,6 +47,7 @@
 from optax.tree_utils._tree_math import tree_real
 from optax.tree_utils._tree_math import tree_scale
 from optax.tree_utils._tree_math import tree_size
+from optax.tree_utils._tree_math import tree_bits
 from optax.tree_utils._tree_math import tree_sub
 from optax.tree_utils._tree_math import tree_sum
 from optax.tree_utils._tree_math import tree_update_infinity_moment

optax/tree_utils/_tree_math.py

@@ -207,6 +207,37 @@ def tree_size(tree: Any) -> int:
   return sum(jnp.size(leaf) for leaf in jax.tree.leaves(tree))
 
 
+def _get_bits(dtype):
+  if jnp.issubdtype(dtype, jnp.integer):
+    return jnp.iinfo(dtype).bits
+  elif jnp.issubdtype(dtype, jnp.floating):
+    return jnp.finfo(dtype).bits
+  elif dtype is bool:
+    return 1
+  else:
+    raise NotImplementedError(f"_get_bits not implemented for {dtype=}")
+
+
+def tree_bits(tree: Any) -> int:
+  r"""Total number of bits in a pytree.
+
+  Args:
+    tree: pytree
+
+  Returns:
+    the total size of the pytree in bits.
+
+  .. warning::
+    It is assumed that every leaf's dtype has an integer byte size.
+    Fractional byte sizes may yield an incorrect result.
+    For example, ``int4`` might be only half a byte on device.
+  """
+  return sum(
+      _get_bits(jnp.asarray(leaf).dtype) * jnp.size(leaf)
+      for leaf in jax.tree.leaves(tree)
+  )
+
+
 def tree_conj(tree: Any) -> Any:
   """Compute the conjugate of a pytree.
 

optax/tree_utils/_tree_math_test.py

@@ -177,6 +177,26 @@ def test_tree_allclose(self):
     assert tu.tree_allclose(1, 1 + 1e-7)
     assert not tu.tree_allclose(1, 2)
 
+  @parameterized.product(
+    size=[1, 10, 100, 1000],
+    dtype=[jnp.int16, jnp.int32, jnp.float16, jnp.float32, jnp.bfloat16],
+  )
+  def test_tree_bits(self, size, dtype):
+    tree = jnp.ones(size, dtype)
+    if dtype == jnp.int16:
+      bits = 16
+    elif dtype == jnp.int32:
+      bits = 32
+    elif dtype == jnp.float16:
+      bits = 16
+    elif dtype == jnp.float32:
+      bits = 32
+    elif dtype == jnp.bfloat16:
+      bits = 16
+    else:
+      raise NotImplementedError(f"{dtype=}")
+    assert tu.tree_bits(tree) == bits * size
+
   def test_tree_conj(self):
     expected = jnp.conj(self.array_a)
     got = tu.tree_conj(self.array_a)