複数の入力にtf.scanを使うケースでValueErrorが出たときの対処法

---

複数の入力に対してtf.scanを使うケースで、入力や引数のshapeが正しいのに「ValueError: The two structures don’t have the same nested structure.」と怒られることがあります。その対処法を見ていきます。

環境：TensorFlow 2.0.0

tf.scanとは

tf.scan
scan on the list of tensors unpacked from elems on dimension 0. （0番目の次元に対して展開したリストに対してスキャンする）
https://www.tensorflow.org/api_docs/python/tf/scan

もっと簡単に言うと、テンソルの1次元目に対してforループを回すようなイメージです。例えば、

agg = 0
for x in array:
    agg += x
print(x)

あくまでイメージです。こんなことをしたいときに便利だったりします。あとはただ単に制御フローとしてforループ感覚でも使えます。ディープラーニングで0番目の次元はほぼバッチ（サンプル）の次元なので、サンプル単位のforループでしょうか。そう考えると使う機会はあると思います。

ちなみに、同種のforループlikeな制御フローを提供する関数として、tf.map_fnという関数がありますが、TPUの対応状況を見るとtf.map_fnが未対応でtf.scanが試験運用中で対応（2019/11/6時点）という状況です。そのため、tf.map_fn感覚でtf.scanを使うということも考えられるでしょう。

基本的な例

まず、引数が1個の例です。

import tensorflow as tf
import numpy as np

def f(agg, x):
    return agg + x    

def single():
    x = np.arange(5).reshape(5, 1).astype(np.float32)

    y = tf.scan(f, x)
    print(y)

fの引数は、aggがこれまでの集約結果、xがスライスしたアイテムを示します。この例では累積和を取っています。結果は以下の通り。

tf.Tensor(
[[ 0.]
 [ 1.]
 [ 3.]
 [ 6.]
 [10.]], shape=(5, 1), dtype=float32)

「0, 1, 2, 3, 4」という入力に対する累積和になっています。

複数引数のケースとValue error

tf.scanのx部分をTupleなどにすると複数引数でも対応可能です。イメージ的にはこういうことができます。

agg = 0
for x1, x2 in zip(array1, array2):
    agg += x1 * x2
print(agg)

同様にtf.scanでも書いてみます。

def f_multi(agg, x):
    a, b = x
    return agg + a * b

def multi():
    x1 = np.arange(5).reshape(5, 1).astype(np.float32)
    x2 = np.arange(5).reshape(5, 1).astype(np.float32)
    y = tf.scan(f_multi, (x1, x2))
    print(y)

ところがこれはエラーになります。

ValueError: The two structures don't have the same nested structure.

First structure: type=tuple str=(array([[0.],
       [1.],
       [2.],
       [3.],
       [4.]], dtype=float32), array([[0.],
       [1.],
       [2.],
       [3.],
       [4.]], dtype=float32))

Second structure: type=EagerTensor str=tf.Tensor(
[[1.]
 [1.]], shape=(2, 1), dtype=float32)

More specifically: Substructure "type=tuple str=(array([[0.],
       [1.],
       [2.],
       [3.],
       [4.]], dtype=float32), array([[0.],
       [1.],
       [2.],
       [3.],
       [4.]], dtype=float32))" is a sequence, while substructure "type=EagerTensor str=tf.Tensor(
[[1.]
 [1.]], shape=(2, 1), dtype=float32)" is not
Entire first structure:
(., .)
Entire second structure:
.

x1もx2も同じshapeなのになぜエラーが出るのでしょうか。

解決法

この原因は集約部分の初期値のshapeです。以下のように、tf.scanのinitialzerを指定するとうまくいきます。

def f_multi(agg, x):
    a, b = x
    return agg + a * b

def multi():
    x1 = np.arange(5).reshape(5, 1).astype(np.float32)
    x2 = np.arange(5).reshape(5, 1).astype(np.float32)
    y = tf.scan(f_multi, (x1, x2), initializer=tf.zeros((1,), dtype=tf.float32)) # ここを追加
    print(y)

if __name__ == "__main__":
    multi()

このケースでは2乗の累積和になります。

tf.Tensor(
[[ 0.]
 [ 1.]
 [ 5.]
 [14.]
 [30.]], shape=(5, 1), dtype=float32)

このケースでは、forループで展開されるのが(1, )（より一般的には1次元目以降のshape）となります。デフォルトではこれを(変数の個数, 1次元目以降のshape)として初期化するため、1変数ではうまくいっても2変数ではうまくいかなくなるようです。

集約をしない場合

「累積和でなくていいから、ただ複数引数の間の計算をしたい」という場合も対応できます。tf.scanで呼び出す関数の中身を少しいじりましょう。

def f_multi(agg, x):
    a, b = x
    return a * b    

def multi():
    x1 = np.arange(5).reshape(5, 1).astype(np.float32)
    x2 = np.arange(5).reshape(5, 1).astype(np.float32)
    y = tf.scan(f_multi, (x1, x2), initializer=tf.zeros((1,), dtype=tf.float32)) 
    print(y)

これはただの2乗になります。

tf.Tensor(
[[ 0.]
 [ 1.]
 [ 4.]
 [ 9.]
 [16.]], shape=(5, 1), dtype=float32)

まとめ

• tf.scan＋複数入力のケースでshapeがあってるのに「shapeが違うぞ」とValue Errorといわれたら、初期化のshapeがおかしい
• tf.scanには集約用の関数であるが、ただのforループ感覚でも使える

---

---

Shikoan's ML Blogの中の人が運営しているサークル「じゅ～しぃ～すくりぷと」の本のご案内

---