einops 0.4 : 概要 (翻訳/解説)

翻訳 : (株)クラスキャット セールスインフォメーション
作成日時 : 03/24/2022 (0.4.1)

* 本ページは、einops の以下のドキュメントを翻訳した上で適宜、補足説明したものです：

• README

* サンプルコードの動作確認はしておりますが、必要な場合には適宜、追加改変しています。
* ご自由にリンクを張って頂いてかまいませんが、sales-info@classcat.com までご一報いただけると嬉しいです。

 

 

einops 0.4 : 概要

可読性と信頼性の高いコードのための柔軟でパワフルな tensor 演算です。numpy, pytorch, tensorflow, jax 等をサポートしています。

 

チュートリアル

チュートリアルは einops を実際に確認する最も便利な方法です :

• part 1: einops 基礎
• part 2: 深層学習のための einops
• part 3: einops で pytorch コードを改良する

 

API

einops は最小主義 (= minimalistic) でありながらパワフルな API を持ちます。

3 つの演算が提供されます (einops チュートリアル はそれらが stacking, reshape, transposition, squeeze/unsqueeze, repeat, tile, concatenate, view そして多くの reduction をカバーしていることを示します) :

from einops import rearrange, reduce, repeat
# パターンに従って要素を再配置 (= rearrange)
output_tensor = rearrange(input_tensor, 't b c -> b c t')
# 再配置とリダクションを結合
output_tensor = reduce(input_tensor, 'b c (h h2) (w w2) -> b h w c', 'mean', h2=2, w2=2)
# 新しい軸に沿ってコピー
output_tensor = repeat(input_tensor, 'h w -> h w c', c=3)

そして同じ API を持つ対応する 2 つの層 (einops は各フレームワークに対して個別のバージョンを保持しています)。

from einops.layers.chainer import Rearrange, Reduce
from einops.layers.gluon import Rearrange, Reduce
from einops.layers.keras import Rearrange, Reduce
from einops.layers.torch import Rearrange, Reduce
from einops.layers.tensorflow import Rearrange, Reduce

層は演算と同様に動作して同じパラメータを持ちます (呼び出しの間に渡される、最初の引数は例外)。

layer = Rearrange(pattern, **axes_lengths)
layer = Reduce(pattern, reduction, **axes_lengths)

# tensor / 変数に作成された層を適用する
x = layer(x)

モデル内の層の使用例 :

# example given for pytorch, but code in other frameworks is almost identical  
from torch.nn import Sequential, Conv2d, MaxPool2d, Linear, ReLU
from einops.layers.torch import Rearrange

model = Sequential(
    Conv2d(3, 6, kernel_size=5),
    MaxPool2d(kernel_size=2),
    Conv2d(6, 16, kernel_size=5),
    MaxPool2d(kernel_size=2),
    # flattening
    Rearrange('b c h w -> b (c h w)'),  
    Linear(16*5*5, 120), 
    ReLU(),
    Linear(120, 10), 
)

 

命名

einops は “Einstein-Inspired Notation for operations” (演算のための Einstein-Inspired 記法) を表します (“Einstein operations” の方がより魅力的で覚えやすいですが)。

記法はおおよそアインシュタインの縮約 (記法) によりインスパイアされました (特に numpy.einsum 演算により)。

 

何故 einops 記法を使うのでしょう？

意味情報 (期待どおりに冗長である)

y = x.view(x.shape[0], -1)
y = rearrange(x, 'b c h w -> b (c h w)')

これらの 2 行は同じコンテキストで同じジョブを行なっていますが、2 番目のものは入力と出力についての情報を提供しています。換言すれば、einops はインターフェイスにフォーカスします : 入力と出力は何か、出力がどのように計算されるかではありません。

次の演算は同様に見えますが :

y = rearrange(x, 'time c h w -> time (c h w)')

しかしそれは読者にヒントを与えます : これは処理している画像の独立したバッチではなく、シークエンス (動画) です。

意味情報はコードを読みやすく保守を容易にします。

 

便利なチェック機能

同じ例を再考します :

y = x.view(x.shape[0], -1) # x: (batch, 256, 19, 19)
y = rearrange(x, 'b c h w -> b (c h w)')

2 行目は入力が 4 次元を持つことをチェックしますが、特定の次元を指定することもできます。それは shape について単にコメントすることとは対照的です、ご存知のように コメントは動作しないしミスを防ぐこともしません。

y = x.view(x.shape[0], -1) # x: (batch, 256, 19, 19)
y = rearrange(x, 'b c h w -> b (c h w)', c=256, h=19, w=19)

 

結果は厳密に決定される

下で depth-to-space 演算を定義するために少なくとも 2 つの方法を持ちます。

# depth-to-space
rearrange(x, 'b c (h h2) (w w2) -> b (c h2 w2) h w', h2=2, w2=2)
rearrange(x, 'b c (h h2) (w w2) -> b (h2 w2 c) h w', h2=2, w2=2)

それを行なうために少なくともあと 4 つの方法があります。フレームワークによりどれが使用されているでしょう？

通常は違いがありませんのでこれらの詳細は無視されますが、(例えば次のステージでグループ化された畳込みを使用する場合) 大きな違いを生み出す可能性があり、コードでこれを指定したいでしょう。

 

統一性

reduce(x, 'b c (x dx) -> b c x', 'max', dx=2)
reduce(x, 'b c (x dx) (y dy) -> b c x y', 'max', dx=2, dy=3)
reduce(x, 'b c (x dx) (y dy) (z dz) -> b c x y z', 'max', dx=2, dy=3, dz=4)

これらのサンプルは 1d/2d/3d プーリングに対して個別の演算を使用しないことを実演しています、これらは総て統一された方法で定義されます。

Space-to-depth と depth-to-space は多くのフレームワークで定義されますが、width-to-height についてはどうでしょう？Here you go :

rearrange(x, 'b c h (w w2) -> b c (h w2) w', w2=2)

 

フレームワーク独立な動作

単純な関数でさえも異なるフレームワークにより異なって定義されます。

y = x.flatten() # or flatten(x)

x の shape が (3, 4, 5) であると仮定すると、y の shape は …

• numpy, cupy, chainer, pytorch: (60,)
• keras, tensorflow.layers, mxnet and gluon: (3, 20)

einops は総てのフレームワークで同じように動作します。

 

フレームワーク擁護の独立性

例: tile vs repeat は多くの混乱を招きます。width に沿って画像をコピーするには :

np.tile(image, (1, 2))    # in numpy
image.repeat(1, 2)        # pytorch's repeat ~ numpy's tile

einops ではどの軸が繰り返されたのか解読する必要はありません :

repeat(image, 'h w -> h (tile w)', tile=2)  # in numpy
repeat(image, 'h w -> h (tile w)', tile=2)  # in pytorch
repeat(image, 'h w -> h (tile w)', tile=2)  # in tf
repeat(image, 'h w -> h (tile w)', tile=2)  # in jax
repeat(image, 'h w -> h (tile w)', tile=2)  # in mxnet
... (etc.)

Testimonials provide user’s perspective on the same question.

 

サポートされるフレームワーク

Einops works with …

• numpy
• pytorch
• tensorflow
• jax
• cupy
• chainer
• gluon
• tf.keras
• mxnet (experimental)

以上