こしあん
2019-01-09

PythonのMessagePack-Numpyで独自のクラスをシリアライズする方法

Pocket
LINEで送る
Delicious にシェア

1.4k{icon} {views}



MessagePackを使ってシリアライズを高速化したかったのですが、独自のクラスやネストされたオブジェクトについてシリアル化する方法が全然なかったので調べてみました。Numpyのシリアライズも使えるMessagePackの拡張版、MessagePack-Numpyを使って確かめます。

MessagePack-Numpy:https://pypi.org/project/msgpack-numpy/

こんなデータをシリアライズしたい

(オブジェクト思考脳だったら)割とよくあるシチュエーション。例えば以下のような商品データがあったとします。

import msgpack_numpy as msgn
import numpy as np

class MerchantData:
    def __init__(self, *values):
        self.id = values[0]
        self.name = values[1]
        self.some_values = values[2]

if __name__ == "__main__":
    np.random.seed(45)
    a = MerchantData(1, "apple", np.random.randn(3))
    b = MerchantData(2, "orange", np.random.randn(3))
    print(a.__dict__)
    print(b.__dict__)

出力はこんな感じ

{'id': 1, 'name': 'apple', 'some_values': array([ 0.02637477,  0.2603217 , -0.3
514554])}
{'id': 2, 'name': 'orange', 'some_values': array([-0.20430091, -1.27163265, -2.
9687863])}

そのままやってもうまくいかない

何も考えずにシリアル化しても怒られてしまってうまくいきません。

def serialize(data):
    pack = msgn.packb(data)
    unpack = msgn.unpackb(pack)

if __name__ == "__main__":
    np.random.seed(45)
    a = MerchantData(1, "apple", np.random.randn(3))
    b = MerchantData(2, "orange", np.random.randn(3))
    data = [a, b]
    serialize(data)
    return Packer(**kwargs).pack(o)
  File "msgpack/_packer.pyx", line 284, in msgpack._packer.Packer.pack
  File "msgpack/_packer.pyx", line 290, in msgpack._packer.Packer.pack
  File "msgpack/_packer.pyx", line 287, in msgpack._packer.Packer.pack
  File "msgpack/_packer.pyx", line 263, in msgpack._packer.Packer._pack
  File "msgpack/_packer.pyx", line 281, in msgpack._packer.Packer._pack
TypeError: can't serialize <__main__.MerchantData object at 0x000000000367F518>

要するに「シリアライズ、デシリアライズの処理が定義されていないから変換できませんよ」ということ。MessagePack-Numpyではなく、通常のMessagePackを使うとNumpy配列を変換しようとするときにこんなメッセージが出ます。変換処理を自分で定義するのが面倒くさいからMessagePack-Numpyを使っているんですね。

安直な方法はdict化してしまう

変換処理書くの面倒くさいからdict化(辞書化)してしまおうというのが楽です。ただし、「packbのときにuse_bin_type=True, unpackbのときにraw=False」のオプションをつけ忘れないようにしましょう。これを忘れるとdictionaryのキーがバイナリー(b”id”みたいな形)で保存されてしまいます。

ちなみにクラスオブジェクトの変数一覧は、インスタンス変数xに対して、x._dict_の属性を取ってくると辞書で取れます。

import msgpack_numpy as msgn
import numpy as np

class MerchantData:
    def __init__(self, *values):
        self.id = values[0]
        self.name = values[1]
        self.some_values = values[2]

def serialize(data):
    pack = msgn.packb(data, use_bin_type=True)
    unpack = msgn.unpackb(pack, raw=False)
    for x in unpack:
        print(x)

if __name__ == "__main__":
    np.random.seed(45)
    a = MerchantData(1, "apple", np.random.randn(3))
    b = MerchantData(2, "orange", np.random.randn(3))
    data = [x.__dict__ for x in [a, b]]
    serialize(data)
{'id': 1, 'name': 'apple', 'some_values': array([ 0.02637477,  0.2603217 , -0.39
514554])}
{'id': 2, 'name': 'orange', 'some_values': array([-0.20430091, -1.27163265, -2.5
9687863])}

こんな感じ。わりかしよさげ。ちなみにpackbとunpackbのオプションを忘れると次のようになります。

# packbのuse_bin_type=Trueと、unpackbのraw=Falseを入れなかった場合
{b'id': 1, b'name': b'apple', b'some_values': array([ 0.02637477,  0.2603217 ,
0.39514554])}
{b'id': 2, b'name': b'orange', b'some_values': array([-0.20430091, -1.27163265
-2.59687863])}

入れ忘れた場合に後から変換するの結構面倒臭そう。これでアクセスできればよいのですが、例えばserializeメソッドのところのprint(x)のところを「print(x.name)」とかやってみると、

AttributeError: 'dict' object has no attribute 'name'

と怒られてしまいます。ちょっとこれは困りました。

この辞書のケースでは、packb/unpackbのオプションを入れてた場合でも、MerchantDataのインスタンスを入力として、出てくるのは辞書なので、辞書→インスタンスに戻す操作を改めて定義しないといけません。これを必要に応じて書くのはちょっとめんどい。

ExtTypeを使ったPackerとUnpackerを定義する

こちらが正式な方法ではないでしょうか。C#でMessagePack使ったときになんかこんなようにプロパティにインデックス振った記憶があるので、多分こうやるのがわかりやすいと思います。

ただ、これでもpackb/unpackbのオプションを忘れると、文字列の値がバイナリーで格納されてしまうので、どっちにしてもpackb/unpackbのオプションは入れないといけません

ただ、こちらの場合はUnpackerの部分でインスタンスに戻すのが完結してしまうので、プログラムの見通しは良くなると思います。ちょっとコードは長くなりますが。公式ドキュメント読んでもいまいちよく理解できなかったのですが、StackOverFlowを見たらよくわかりました。

https://stackoverflow.com/questions/35863822/using-msgpack-python-with-nested-namedtuples

MessagePackでシリアライズしている間はリストとして持っておくのが良いのではないでしょうか。

import msgpack_numpy as msgn
import numpy as np

class MerchantData:
    def __init__(self, *values):
        self.id = values[0]
        self.name = values[1]
        self.some_values = values[2]

def ext_pack(x):
    if isinstance(x, MerchantData):
        return msgn.msgpack.ExtType(1, msgn.packb([y for y in x.__dict__.values()], default=ext_pack, use_bin_type=True))
    return x

def ext_unpack(code, data):
    if code==1:
        unpack = msgn.unpackb(data, ext_hook=ext_pack, raw=False)
        return MerchantData(*unpack)
    return msgn.msgpack.ExtType(code, data)

def serialize(data):
    pack = msgn.packb(data, default=ext_pack, use_bin_type=True)
    unpack = msgn.unpackb(pack, ext_hook=ext_unpack, raw=False)
    for x in unpack:
        print(x)
        print(x.__dict__)

if __name__ == "__main__":
    np.random.seed(45)
    a = MerchantData(1, "apple", np.random.randn(3))
    b = MerchantData(2, "orange", np.random.randn(3))
    data = [a, b]
    serialize(data)
<__main__.MerchantData object at 0x000000000366D978>
{'id': 1, 'name': 'apple', 'some_values': array([ 0.02637477,  0.2603217 , -0.
514554])}
<__main__.MerchantData object at 0x000000000366D9E8>
{'id': 2, 'name': 'orange', 'some_values': array([-0.20430091, -1.27163265, -2
9687863])}

こんな感じ。_dict_とコンストラクタの可変長引数を活用すると綺麗にかけると思います。いちいち変数増えるたびに引数追加してたらかっこ悪いですからね。

こちらはインスタンスからインスタンスのPack/Unpackなので自然な形になりました。

まとめ

MessagePackのカスタムクラスのシリアライズは、

  • 文字列の値はバイナリーでパッキングされないように、packbで「use_bin_type=True」、unpackbで「raw=False」を入れる(どちらの方法でも)
  • 手軽な方法は辞書で保存して読み込むのだけれども、読み込んだ後に辞書→インスタンス変数への変換をMessagePackの外側で書かないといけないからちょっと美しくない
  • おそらく正式な方法は、ExtTypeを使ってPack/Unpackを個別に定義するものだと思われる

とのことでした。MessagePackのPythonの例はいろいろ探しましたが情報が少なく、自分もかなりモヤモヤしていたので、これでわかってすっきりしました。



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

技術書コーナー

【新刊】インフィニティNumPy――配列の初期化から、ゲームの戦闘、静止画や動画作成までの221問

「本当の実装力を身につける」ための221本ノック――
機械学習(ML)で避けて通れない数値計算ライブラリ・NumPyを、自在に活用できるようになろう。「できる」ための体系的な理解を目指します。基礎から丁寧に解説し、ディープラーニング(DL)の難しいモデルで遭遇する、NumPyの黒魔術もカバー。初心者から経験者・上級者まで楽しめる一冊です。問題を解き終わったとき、MLやDLなどの発展分野にスムーズに入っていけるでしょう。

本書の大きな特徴として、Pythonの本でありがちな「NumPyとML・DLの結合を外した」点があります。NumPyを理解するのに、MLまで理解するのは負担が大きいです。本書ではあえてこれらの内容を書いていません。行列やテンソルの理解に役立つ「従来の画像処理」をNumPyベースで深く解説・実装していきます。

しかし、問題の多くは、DLの実装で頻出の関数・処理を重点的に取り上げています。経験者なら思わず「あー」となるでしょう。関数丸暗記では自分で実装できません。「覚える関数は最小限、できる内容は無限大」の世界をぜひ体験してみてください。画像編集ソフトの処理をNumPyベースで実装する楽しさがわかるでしょう。※紙の本は電子版の特典つき

モザイク除去から学ぶ 最先端のディープラーニング

「誰もが夢見るモザイク除去」を起点として、機械学習・ディープラーニングの基本をはじめ、GAN(敵対的生成ネットワーク)の基本や発展型、ICCV, CVPR, ECCVといった国際学会の最新論文をカバーしていく本です。
ディープラーニングの研究は発展が目覚ましく、特にGANの発展型は市販の本でほとんどカバーされていない内容です。英語の原著論文を著者がコードに落とし込み、実装を踏まえながら丁寧に解説していきます。
また、本コードは全てTensorFlow2.0(Keras)に対応し、Googleの開発した新しい機械学習向け計算デバイス・TPU(Tensor Processing Unit)をフル活用しています。Google Colaboratoryを用いた環境構築不要の演習問題もあるため、読者自ら手を動かしながら理解を深めていくことができます。

AI、機械学習、ディープラーニングの最新事情、奥深いGANの世界を知りたい方にとってぜひ手にとっていただきたい一冊となっています。持ち運びに便利な電子書籍のDLコードが付属しています。

「おもしろ同人誌バザールオンライン」で紹介されました!(14:03~) https://youtu.be/gaXkTj7T79Y?t=843

まとめURL:https://github.com/koshian2/MosaicDeeplearningBook
A4 全195ページ、カラー12ページ / 2020年3月発行

Shikoan's ML Blog -Vol.1/2-

累計100万PV超の人気ブログが待望の電子化! このブログが電子書籍になって読みやすくなりました!

・1章完結のオムニバス形式
・機械学習の基本からマニアックなネタまで
・どこから読んでもOK
・何巻から読んでもOK

・短いものは2ページ、長いものは20ページ超のものも…
・通勤・通学の短い時間でもすぐ読める!
・読むのに便利な「しおり」機能つき

・全巻はA5サイズでたっぷりの「200ページオーバー」
・1冊にたっぷり30本収録。1本あたり18.3円の圧倒的コストパフォーマンス!
・文庫本感覚でお楽しみください

北海道の駅巡りコーナー

日高本線 車なし全駅巡り

ローカル線や秘境駅、マニアックな駅に興味のある方におすすめ! 2021年に大半区間が廃線になる、北海道の日高本線の全区間・全29駅(苫小牧~様似)を記録した本です。マイカーを使わずに、公共交通機関(バス)と徒歩のみで全駅訪問を行いました。日高本線が延伸する計画のあった、襟裳岬まで様似から足を伸ばしています。代行バスと路線バスの織り成す極限の時刻表ゲームと、絶海の太平洋と馬に囲まれた日高路、日高の隠れたグルメを是非たっぷり堪能してください。A4・フルカラー・192ページのたっぷりのボリュームで、あなたも旅行気分を漫喫できること待ったなし!

見どころ:日高本線被災区間(大狩部、慶能舞川橋梁、清畠~豊郷) / 牧場に囲まれた絵笛駅 / 窓口のあっただるま駅・荻伏駅 / 汐見の戦争遺跡のトーチカ / 新冠温泉、三石温泉 / 襟裳岬

A4 全192ページフルカラー / 2020年11月発行


Pocket
LINEで送る
Delicious にシェア

Add a Comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です