Comparison Between TreeValue and Jax LibTree

In this section, we will take a look at the feature and performance of the jax-libtree library, which is developed by Google.

_TREE_DATA_1 = {'a': 1, 'b': 2, 'x': {'c': 3, 'd': 4}}

Mapping Operation

TreeValue’s Mapping

from treevalue import mapping, FastTreeValue

t = FastTreeValue(_TREE_DATA_1)
mapping(t, lambda x: x ** 2)

/tmp/tmp4q2ykbbk/695148caffa69afacf344700cfd634bb66038ba6/treevalue/tree/integration/torch.py:23: FutureWarning: `torch.utils._pytree._register_pytree_node` is deprecated. Please use `torch.utils._pytree.register_pytree_node` instead.
  register_for_torch(TreeValue)
/tmp/tmp4q2ykbbk/695148caffa69afacf344700cfd634bb66038ba6/treevalue/tree/integration/torch.py:24: FutureWarning: `torch.utils._pytree._register_pytree_node` is deprecated. Please use `torch.utils._pytree.register_pytree_node` instead.
  register_for_torch(FastTreeValue)

%timeit mapping(t, lambda x: x ** 2)

2.64 µs ± 3.89 ns per loop (mean ± std. dev. of 7 runs, 100,000 loops each)

mapping(t, lambda x, p: (x ** 2, p))

%timeit mapping(t, lambda x, p: (x ** 2, p))

2.7 µs ± 3.03 ns per loop (mean ± std. dev. of 7 runs, 100,000 loops each)

pytree’s tree_map

from jax.tree_util import tree_map

tree_map(lambda x: x ** 2, _TREE_DATA_1)

{'a': 1, 'b': 4, 'x': {'c': 9, 'd': 16}}

%timeit tree_map(lambda x: x ** 2, _TREE_DATA_1)

4.57 µs ± 23.3 ns per loop (mean ± std. dev. of 7 runs, 100,000 loops each)

Flatten and Unflatten Operation

TreeValue’s Performance

from treevalue import flatten, flatten_keys, flatten_values

t_flatted = flatten(t)
t_flatted

[(('a',), 1), (('b',), 2), (('x', 'c'), 3), (('x', 'd'), 4)]

%timeit flatten(t)

508 ns ± 3.05 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

from treevalue import flatten_keys

flatten_keys(t)

[('a',), ('b',), ('x', 'c'), ('x', 'd')]

%timeit flatten_keys(t)

457 ns ± 2.9 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

from treevalue import flatten_values

flatten_values(t)

[1, 2, 3, 4]

%timeit flatten_values(t)

335 ns ± 3.03 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

from treevalue import unflatten

unflatten(t_flatted)

%timeit unflatten(t_flatted)

611 ns ± 3.31 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

pytree’s Performance

from jax.tree_util import tree_flatten

leaves, treedef = tree_flatten(_TREE_DATA_1)
print('Leaves:', leaves)
print('Treedef:', treedef)

Leaves: [1, 2, 3, 4]
Treedef: PyTreeDef({'a': *, 'b': *, 'x': {'c': *, 'd': *}})

%timeit tree_flatten(_TREE_DATA_1)

1.39 µs ± 5.95 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

from jax.tree_util import tree_unflatten

tree_unflatten(treedef, leaves)

{'a': 1, 'b': 2, 'x': {'c': 3, 'd': 4}}

%timeit tree_unflatten(treedef, leaves)

681 ns ± 4.69 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

All Operation

TreeValue’s Performance

all(flatten_values(t))

True

%timeit all(flatten_values(t))

436 ns ± 0.748 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

pytree.tree_all’s performance

from jax.tree_util import tree_all

tree_all(_TREE_DATA_1)

True

%timeit tree_all(_TREE_DATA_1)

1.59 µs ± 8.88 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

Reduce Operation

TreeValue’s Reduce

from functools import reduce

def _flatten_reduce(tree):
    values = flatten_values(tree)
    return reduce(lambda x, y: x + y, values)

_flatten_reduce(t)

10

%timeit _flatten_reduce(t)

817 ns ± 1.96 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

def _flatten_reduce_with_init(tree):
    values = flatten_values(tree)
    return reduce(lambda x, y: x + y, values, 0)

_flatten_reduce_with_init(t)

10

%timeit _flatten_reduce_with_init(t)

857 ns ± 4.96 ns per loop (mean ± std. dev. of 7 runs, 1,000,000 loops each)

pytree.tree_reduce

from jax.tree_util import tree_reduce

tree_reduce(lambda x, y: x + y, _TREE_DATA_1)

10

%timeit tree_reduce(lambda x, y: x + y, _TREE_DATA_1)

2.09 µs ± 16.7 ns per loop (mean ± std. dev. of 7 runs, 100,000 loops each)

tree_reduce(lambda x, y: x + y, _TREE_DATA_1, 0)

10

%timeit tree_reduce(lambda x, y: x + y, _TREE_DATA_1, 0)

2.15 µs ± 7.05 ns per loop (mean ± std. dev. of 7 runs, 100,000 loops each)

Structure Transpose

Subside and Rise in TreeValue

from treevalue import subside

value = {
    'a': FastTreeValue({'a': 1, 'b': {'x': 2, 'y': 3}}),
    'b': FastTreeValue({'a': 10, 'b': {'x': 20, 'y': 30}}),
    'c': {
        'x': FastTreeValue({'a': 100, 'b': {'x': 200, 'y': 300}}),
        'y': FastTreeValue({'a': 400, 'b': {'x': 500, 'y': 600}}),
    },
}
subside(value)

%timeit subside(value)

10.3 µs ± 56.6 ns per loop (mean ± std. dev. of 7 runs, 100,000 loops each)

from treevalue import raw, rise

value = FastTreeValue({
    'a': raw({'a': 1, 'b': {'x': 2, 'y': 3}}),
    'b': raw({'a': 10, 'b': {'x': 20, 'y': 30}}),
    'c': {
        'x': raw({'a': 100, 'b': {'x': 200, 'y': 300}}),
        'y': raw({'a': 400, 'b': {'x': 500, 'y': 600}}),
    },
})
rise(value)

{'b': {'y': <FastTreeValue 0x7f277afc9880>
  ├── 'a' --> 3
  ├── 'b' --> 30
  └── 'c' --> <FastTreeValue 0x7f277afc9820>
      ├── 'x' --> 300
      └── 'y' --> 600,
  'x': <FastTreeValue 0x7f277afc97c0>
  ├── 'a' --> 2
  ├── 'b' --> 20
  └── 'c' --> <FastTreeValue 0x7f277afc9d30>
      ├── 'x' --> 200
      └── 'y' --> 500},
 'a': <FastTreeValue 0x7f2842eabdf0>
 ├── 'a' --> 1
 ├── 'b' --> 10
 └── 'c' --> <FastTreeValue 0x7f2842eabbb0>
     ├── 'x' --> 100
     └── 'y' --> 400}

%timeit rise(value)

11.3 µs ± 64.2 ns per loop (mean ± std. dev. of 7 runs, 100,000 loops each)

vt = {'a': None, 'b': {'x': None, 'y': None}}
rise(value, template=vt)

{'a': <FastTreeValue 0x7f2842eaba90>
 ├── 'a' --> 1
 ├── 'b' --> 10
 └── 'c' --> <FastTreeValue 0x7f2842eab730>
     ├── 'x' --> 100
     └── 'y' --> 400,
 'b': {'x': <FastTreeValue 0x7f2842eabd30>
  ├── 'a' --> 2
  ├── 'b' --> 20
  └── 'c' --> <FastTreeValue 0x7f2842eabeb0>
      ├── 'x' --> 200
      └── 'y' --> 500,
  'y': <FastTreeValue 0x7f2842eab4c0>
  ├── 'a' --> 3
  ├── 'b' --> 30
  └── 'c' --> <FastTreeValue 0x7f2842eabca0>
      ├── 'x' --> 300
      └── 'y' --> 600}}

%timeit rise(value, template=vt)

9.12 µs ± 69.7 ns per loop (mean ± std. dev. of 7 runs, 100,000 loops each)

pytree.tree_transpose

from jax.tree_util import tree_structure, tree_transpose

sto = tree_structure({'a': 1, 'b': 2, 'c': {'x': 3, 'y': 4}})
sti = tree_structure({'a': 1, 'b': {'x': 2, 'y': 3}})

value = (
    {'a': 1, 'b': {'x': 2, 'y': 3}},
    {
        'a': {'a': 10, 'b': {'x': 20, 'y': 30}},
        'b': [
            {'a': 100, 'b': {'x': 200, 'y': 300}},
            {'a': 400, 'b': {'x': 500, 'y': 600}},
        ],
    }
)
tree_transpose(sto, sti, value)

{'a': {'a': 1, 'b': 10, 'c': {'x': 100, 'y': 400}},
 'b': {'x': {'a': 2, 'b': 20, 'c': {'x': 200, 'y': 500}},
  'y': {'a': 3, 'b': 30, 'c': {'x': 300, 'y': 600}}}}

%timeit tree_transpose(sto, sti, value)

9.85 µs ± 30.2 ns per loop (mean ± std. dev. of 7 runs, 100,000 loops each)