Apply into NumpyΒΆ

In following parts, we will show some demos about how to use TreeValue in practice.

For example, now we have a group of structed data in python-dict type, we want to do different operations on differnent key-value pairs inplace, get some statistics such as mean value and task some slices.

In normal cases, we need to unroll multiple for-loop and if-else to implement cooresponding operations on each values, and declare additional temporal variables to save result. All the mentioned contents are executed serially, like the next code examples:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
import numpy as np

T, B = 3, 4


def without_treevalue(batch_):
    mean_b_list = []
    even_index_a_list = []
    for i in range(len(batch_)):
        for k, v in batch_[i].items():
            if k == 'a':
                v = v.astype(np.float32)
                even_index_a_list.append(v[::2])
            elif k == 'b':
                v = v.astype(np.float32)
                transformed_v = np.power(v, 2) + 1.0
                mean_b_list.append(transformed_v.mean())
            elif k == 'c':
                for k1, v1 in v.items():
                    if k1 == 'd':
                        v1 = v1.astype(np.float32)
                    else:
                        print('ignore keys: {}'.format(k1))
            else:
                print('ignore keys: {}'.format(k))
    for i in range(len(batch_)):
        for k in batch_[i].keys():
            if k == 'd':
                batch_[i][k]['noise'] = np.random.random(size=(3, 4, 5))

    mean_b = sum(mean_b_list) / len(mean_b_list)
    even_index_a = np.stack(even_index_a_list, axis=0)
    return batch_, mean_b, even_index_a

However, with the help of TreeValue, all the contents mentioned above can be implemented gracefully and efficiently. Users only need to func_treelize the primitive numpy functions and pack data with FastTreeValue, then execute desired operations just like using standard numpy array.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import numpy as np

from treevalue import FastTreeValue

T, B = 3, 4
power = FastTreeValue.func()(np.power)
stack = FastTreeValue.func(subside=True)(np.stack)
split = FastTreeValue.func(rise=True)(np.split)


def with_treevalue(batch_):
    batch_ = [FastTreeValue(b) for b in batch_]
    batch_ = stack(batch_)
    batch_ = batch_.astype(np.float32)
    batch_.b = power(batch_.b, 2) + 1.0
    batch_.c.noise = np.random.random(size=(B, 3, 4, 5))
    mean_b = batch_.b.mean()
    even_index_a = batch_.a[:, ::2]
    batch_ = split(batch_, indices_or_sections=B, axis=0)
    return batch_, mean_b, even_index_a

And we can run these two demos for comparison:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
import copy

import numpy as np
from with_treevalue import with_treevalue
from without_treevalue import without_treevalue

T, B = 3, 4


def get_data():
    return {
        'a': np.random.random(size=(T, 8)),
        'b': np.random.random(size=(6,)),
        'c': {
            'd': np.random.randint(0, 10, size=(1,))
        }
    }


if __name__ == "__main__":
    batch = [get_data() for _ in range(B)]
    batch0, mean0, even_index_a0 = without_treevalue(copy.deepcopy(batch))
    batch1, mean1, even_index_a1 = with_treevalue(copy.deepcopy(batch))

    assert np.abs(mean0 - mean1) < 1e-6
    print('mean0 & mean1:', mean0, mean1)
    print('\n')

    assert np.abs((even_index_a0 - even_index_a1).max()) < 1e-6
    print('even_index_a0:', even_index_a0)
    print('even_index_a1:', even_index_a1)

    assert len(batch0) == B
    assert len(batch1) == B

The final output should be the text below, and all the assertions can be passed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
mean0 & mean1: 1.3630598187446594 1.3630599


even_index_a0: [[[0.22866061 0.36012933 0.4482926  0.30301735 0.6483379  0.9293952
   0.02292843 0.18404031]
  [0.4211347  0.7952928  0.69251317 0.60090697 0.737283   0.67821234
   0.72110415 0.95793265]]

 [[0.05478287 0.84214664 0.89434785 0.7458131  0.17807789 0.25477663
   0.12964407 0.70232207]
  [0.45694712 0.16549645 0.29223216 0.8674646  0.15820047 0.04931645
   0.4340334  0.5445387 ]]

 [[0.06413265 0.7854897  0.25766864 0.9217309  0.64705396 0.8808966
   0.89802945 0.13922621]
  [0.22362663 0.07468738 0.25544697 0.5119003  0.27958676 0.5045413
   0.4510338  0.9592029 ]]

 [[0.73482996 0.7666177  0.75204813 0.18470363 0.28963074 0.33868033
   0.22880636 0.311551  ]
  [0.34344628 0.5490768  0.25932807 0.21593206 0.66450924 0.8937747
   0.30728912 0.99314374]]]
even_index_a1: [[[0.22866061 0.36012933 0.4482926  0.30301735 0.6483379  0.9293952
   0.02292843 0.18404031]
  [0.4211347  0.7952928  0.69251317 0.60090697 0.737283   0.67821234
   0.72110415 0.95793265]]

 [[0.05478287 0.84214664 0.89434785 0.7458131  0.17807789 0.25477663
   0.12964407 0.70232207]
  [0.45694712 0.16549645 0.29223216 0.8674646  0.15820047 0.04931645
   0.4340334  0.5445387 ]]

 [[0.06413265 0.7854897  0.25766864 0.9217309  0.64705396 0.8808966
   0.89802945 0.13922621]
  [0.22362663 0.07468738 0.25544697 0.5119003  0.27958676 0.5045413
   0.4510338  0.9592029 ]]

 [[0.73482996 0.7666177  0.75204813 0.18470363 0.28963074 0.33868033
   0.22880636 0.311551  ]
  [0.34344628 0.5490768  0.25932807 0.21593206 0.66450924 0.8937747
   0.30728912 0.99314374]]]

In this case, we can see that the TreeValue can be properly applied into the numpy library. The tree-structured matrix calculation can be easily built with TreeValue like using standard numpy array.

Both the simplicity of logic structure and execution efficiency can be improve a lot.

And Last but not least, the only thing you need to do is to wrap the functions in Numpy library, and then use it painlessly like the primitive numpy.