オープンソースDeepLearningフレームワークのCAFFEのLayerを作る ~ DataLayer編 ~
前回はInnerProductLayerのような一般の処理に関するレイヤーについて書いたので、今回はDataLayerについてメモ。自分が使いたいデータフォーマットの形式に対応してないとかよくあると思うので作れるようになっておくと良さそう。(LevelDB、MDB、HDF5使えば大体いけるお思うが。マルチインプットとかいろいろ問題ありそう)
既存のデータレイヤーを見ていく
ざっと見てみると完全に画像入力を前提としているように見受けられる。API Docから継承関係を見てみると、Layer–>BaseDataLayer–>MemoryDataLayerの筋とLayer–>BaseDataLayer–>BasePrefetchDataLayer–>{DataLayer,ImageDataLayer,WindowDataLayer}等の筋がある(投稿時)。
BaseDataLayer
はおおよそすべてのDataLayerの親になっていてLayerSetUpメソッドと必要なメンバ変数を定義している。このクラスを継承したレイヤーはTransformParameterをもつことができ、画像のランダムクロップやランダムミラーリング、色変換(スケーリング、差分)を行う。
// Message that stores parameters used to apply transformation
// to the data layer's data
message TransformationParameter {
// For data pre-processing, we can do simple scaling and subtracting the
// data mean, if provided. Note that the mean subtraction is always carried
// out before scaling.
optional float scale = 1 [default = 1];
// Specify if we want to randomly mirror data.
optional bool mirror = 2 [default = false];
// Specify if we would like to randomly crop an image.
optional uint32 crop_size = 3 [default = 0];
optional string mean_file = 4;
}
LayerSetupの中身はこのTransform等の初期化を行う。また、本クラスから継承される子クラスで実装されるルールとなっているDataLayerSetUpを呼び出している。
MemoryDataLayer
を例に見てみる。(これはDeployの時などに使われるように作られている。あとメモリに乗り切るデータを扱う場合に使える。と思う。ただし、tools/caffe.cppからそのまま呼べる形にはなっていない模様。なぜならデータをセットする必要があるため。)
// Message that stores parameters used by MemoryDataLayer
message MemoryDataParameter {
optional uint32 batch_size = 1;
optional uint32 channels = 2;
optional uint32 height = 3;
optional uint32 width = 4;
}
DataLayerSetUp
メソッドを見ると単純にtop blobのReshapeをしているのが主な処理のよう。このLayerを使うにはForwardするまえにAddDatumVectorでデータをセットしておく必要がある。Forwardの中を見ると、
template <typename Dtype>
void MemoryDataLayer<Dtype>::Forward_cpu(const vector<Blob<Dtype>*>& bottom,
vector<Blob<Dtype>*>* top) {
CHECK(data_) << "MemoryDataLayer needs to be initalized by calling Reset";
(*top)[0]->set_cpu_data(data_ + pos_ * this->datum_size_);
(*top)[1]->set_cpu_data(labels_ + pos_);
pos_ = (pos_ + batch_size_) % n_;
has_new_data_ = false;
}
Forwardを呼ぶたびにデータの読み出し位置のカウンタであるpos_が進むようになっており、1週回ると0に戻るように実装してある(全サンプル数がbatch_sizeの整数倍である必要がある)。データレイヤーではこのようなルールで実装する必要があるようだ。
さて、別筋の親クラスであるBasePrefetchingDataLayer
を見ている。データをファイルシステム等から読み出すときにはデータ転送時間や前処理時間がボトルネックになる。そのため、スレッドを立ち上げてネットのForwardが伝搬している間に裏でデータ読込と前処理を行い、オーバーヘッドをなくす。
// include/caffe/data_layers.hpp
template <typename Dtype>
class BasePrefetchingDataLayer :
public BaseDataLayer<Dtype>, public InternalThread {
public:
explicit BasePrefetchingDataLayer(const LayerParameter& param)
: BaseDataLayer<Dtype>(param) {}
virtual ~BasePrefetchingDataLayer() {}
// LayerSetUp: implements common data layer setup functionality, and calls
// DataLayerSetUp to do special data layer setup for individual layer types.
// This method may not be overridden.
void LayerSetUp(const vector<Blob<Dtype>*>& bottom,
vector<Blob<Dtype>*>* top);
virtual void Forward_cpu(const vector<Blob<Dtype>*>& bottom,
vector<Blob<Dtype>*>* top);
virtual void Forward_gpu(const vector<Blob<Dtype>*>& bottom,
vector<Blob<Dtype>*>* top);
virtual void CreatePrefetchThread();
virtual void JoinPrefetchThread();
// The thread's function
virtual void InternalThreadEntry() {}
protected:
Blob<Dtype> prefetch_data_;
Blob<Dtype> prefetch_label_;
};
継承元であるInternalThread
クラスではboost:threadをラッパーしたThread
クラスを用いてThreadをStart/Joinさせるメソッドを提供し、InternalThreadEntry
メソッドをオーバーライドしてThread内の処理を記述するようになっている。本クラスでは初期化時(LayerSetUp)にThreadをStartしてデータの読み込み(これの子クラスで処理を定義)をさせ、Forward_{cpu,gpu}のメソッドの最初でThreadのJoin(データの読込の完了待ち)をして、読み込んだデータがprefetch_data_
とprefetch_label_
に格納されている(子クラスで実装)のでそれをtop blobに伝搬し、終わりにスレッドを生成して、裏でデータ読込をさせる仕組みとなっている。子クラスでは主にDataLayerSetUpとInternalThreadEntryをオーバーライドして定義するのがメインになる。
実際の実装クラスである(多分1番わかりやすい)ImageDataLayer
を見ていく。
// include/caffe/data_layers.hpp
/**
* @brief Provides data to the Net from image files.
*
* TODO(dox): thorough documentation for Forward and proto params.
*/
template <typename Dtype>
class ImageDataLayer : public BasePrefetchingDataLayer<Dtype> {
public:
explicit ImageDataLayer(const LayerParameter& param)
: BasePrefetchingDataLayer<Dtype>(param) {}
virtual ~ImageDataLayer();
virtual void DataLayerSetUp(const vector<Blob<Dtype>*>& bottom,
vector<Blob<Dtype>*>* top);
virtual inline LayerParameter_LayerType type() const {
return LayerParameter_LayerType_IMAGE_DATA;
}
virtual inline int ExactNumBottomBlobs() const { return 0; }
virtual inline int ExactNumTopBlobs() const { return 2; }
protected:
shared_ptr<Caffe::RNG> prefetch_rng_;
virtual void ShuffleImages();
virtual void InternalThreadEntry();
vector<std::pair<std::string, int> > lines_;
int lines_id_;
};
Protobufの定義はこんな感じ
// src/caffe/proto/caffe.proto
// Message that stores parameters used by ImageDataLayer
message ImageDataParameter {
// Specify the data source.
optional string source = 1;
// Specify the batch size.
optional uint32 batch_size = 4;
// ... 省略
// Whether or not ImageLayer should shuffle the list of files at every epoch.
optional bool shuffle = 8 [default = false];
// It will also resize images if new_height or new_width are not zero.
optional uint32 new_height = 9 [default = 0];
optional uint32 new_width = 10 [default = 0];
// ... 省略
}
実装クラスなので、ExactNum{Bottom,Top}Blobsなどの入出力の数を決めるメソッドやtypeなどは必要。ImageDataLayerは次のようなフォーマットのテキストファイルをソースとして画像を読み込む。
フィイルパス1 ラベル1
フィイルパス2 ラベル2
...
フィイルパスN ラベルN
new_{height,width}
をセットすると画像は自動的にそのサイズにリサイズされる。また、TransformParameter
も設定できるのでそこで階調スケーリング、ランダムミラー・クロップを定義できる。DataLayerSetUp
メソッドではソースのテキストファイルをパースして、pair(ファイルパス、ラベル)のリストlines_
として保持し、最初のデータを少し読みだして、top, prefetchのblobのReshapeを行うなど。実際の読込の処理部はInternalThreadEntry
メソッドで定義され、実に単純でbatch_size_
分だけlines_から画像(同時にTransform)とラベルを読み込んでprefetch_data_
、prefetch_label_
に格納、line_id_
をインクリメントし、リストをすべて走査したら、line_id_
を0に戻し、shuffle=true
の場合lines_
をシャッフルする。どうやらThreadの後始末をするデストラクタは実装する必要があるみたい。以上。
これで大体仕組みはわかったので、データレイヤの実装手順を実際にやってみる
データレイヤーを実装する。
ここではLIBSVMのフォーマットファイルからデータを読み込む例を実装してみる。 libsvmのフォーマットファイルはこんな感じ。
<label> <index1>:<value1> <index2>:<value2> ...
これを読めるようにしたい。
1. Caffe.protoの実装
必要な設定を追加する。
// Message that stores parameters used by LIBSVMDataLayer
message LIBSVMDataParameter {
required string source = 1; // path to libsvm input text file
optional uint32 batch_size = 2;
required uint32 channels = 3; // number of features
optional bool shuffle = 4 [default = false];
}
つづいて、すべてを司るLayerParameterにLIBSVMDataParameterのメンバを加える。LayerTypeも忘れずに追加。
@@ -198,7 +198,7 @@
// NOTE
// Update the next available ID when you add a new LayerParameter field.
//
-// LayerParameter next available ID: 41 (last added: contrastive_loss_param)
+// LayerParameter next available ID: 42 (last added: libsvm_data_param)
message LayerParameter {
repeated string bottom = 2; // the name of the bottom blobs
repeated string top = 3; // the name of the top blobs
@@ -219,7 +219,7 @@
// line above the enum. Update the next available ID when you add a new
// LayerType.
//
- // LayerType next available ID: 38 (last added: CONTRASTIVE_LOSS)
+ // LayerType next available ID: 39 (last added: LIBSVM_DATA)
enum LayerType {
// "NONE" layer type is 0th enum element so that we don't cause confusion
// by defaulting to an existent LayerType (instead, should usually error if
@@ -245,6 +245,7 @@
IMAGE_DATA = 12;
INFOGAIN_LOSS = 13;
INNER_PRODUCT = 14;
+ LIBSVM_DATA = 38;
LRN = 15;
MEMORY_DATA = 29;
MULTINOMIAL_LOGISTIC_LOSS = 16;
@@ -305,6 +306,7 @@
optional ImageDataParameter image_data_param = 15;
optional InfogainLossParameter infogain_loss_param = 16;
optional InnerProductParameter inner_product_param = 17;
+ optional LIBSVMDataParameter libsvm_data_param = 41;
optional LRNParameter lrn_param = 18;
optional MemoryDataParameter memory_data_param = 22;
optional MVNParameter mvn_param = 34;
}
以上。簡単。
2. Layerを実装する
inclulde/caffe/data_layers.hpp
にLIBSVMDataLayer
の宣言する。ImageDataLayer
からコピって作った。
/**
* @brief Provides data to the Net from LIBSVM data format file
*
* Note that this layer reads and stores all data into memory at the
* intialization stage
*
* TODO(dox): thorough documentation for Forward and proto params.
*/
template <typename Dtype>
class LIBSVMDataLayer : public BasePrefetchingDataLayer<Dtype> {
public:
explicit LIBSVMDataLayer(const LayerParameter& param)
: BasePrefetchingDataLayer<Dtype>(param) {}
virtual ~LIBSVMDataLayer();
virtual void DataLayerSetUp(const vector<Blob<Dtype>*>& bottom,
vector<Blob<Dtype>*>* top);
virtual inline LayerParameter_LayerType type() const {
return LayerParameter_LayerType_LIBSVM_DATA;
}
virtual inline int ExactNumBottomBlobs() const { return 0; }
virtual inline int ExactNumTopBlobs() const { return 2; }
protected:
shared_ptr<Caffe::RNG> prefetch_rng_;
virtual void ShuffleAccessOrder();
virtual void InternalThreadEntry();
/// all data are stored into `data_` and `labels_`
vector<shared_ptr<Datum> > data_;
vector<float> labels_;
int pos_;
/// Determine accessing order for shuffling
vector<unsigned int> access_order_;
};
読み込んだデータはdata_
とlabels_
に格納される。data_
の要素はDatum
型で1サンプルごとに保存する。ただし、datum.label()はint型なため使わずにlabels_にラベルを格納することにした。
ここでDatum
を使う理由は、ImageDataLayerでも使われているTransform
(crop, mirror, scale, mean)がDatumを入力として行われるため、同じようにした。
ただし、読み込んだデータは(channels, 1, 1)のShapeとなるので、mirrorとcropは意味をなさないのでセットできないようにしている。
ShuffleAccessOrder()
はSGDのデータのランダムシャッフルを有効にするためのヘルパーメソッドで、メンバのaccess_order_
(データへのアクセス順序が保持されている)をエポックごとに並び替えている。
src/caffe/layers/libsvm_data_layer.cpp
を作成(image_data_layer.cpp
からの完コピからのスタート)。
src/caffe/layers/libsvm_data_layer.cpp
LIBSVMフォーマットの読込み、data_
とlabels_
にデータを格納する部分をDataLayerSetUp()
で実装。
非同期でデータの読み出しを行うInternalThreadEntry()
でdata_
, labels_
からaccess_order_
の順番にしたがってデータを読み出し、
Transform
を実行した結果をprefetch_data_
、prefetch_label_
にセットしておく(親クラスのBasePrefetchingLayer
でそういうルールとして決まっている)。
3. テストコードを書く
これも基本test_image_data_layer.cpp
からのコピーから実装をスタート。読込がうまく言っているかのTestReadとランダムシャッフルがうまくいくかのTestShuffleを実装した。
make test が通るようになれば動いているはず。
4. レイヤーファクトリに登録
Prototxtのネット定義のenum LayerType の LIBSVM_DATA からLIBSVMDataLayerを生成できるように登録する。
@@ -219,6 +219,8 @@ Layer<Dtype>* GetLayer(const LayerParameter& param) {
return new InfogainLossLayer<Dtype>(param);
case LayerParameter_LayerType_INNER_PRODUCT:
return new InnerProductLayer<Dtype>(param);
+ case LayerParameter_LayerType_LIBSVM_DATA:
+ return new LIBSVMDataLayer<Dtype>(param);
case LayerParameter_LayerType_LRN:
return new LRNLayer<Dtype>(param);
case LayerParameter_LayerType_MEMORY_DATA:
5. LINT対策
コーディングスタイルが揃う目的等で使われているLINTのエラーが起こったので次の対策をした。
# scripts/cpp_lint.py
@@ -1610,6 +1610,7 @@ def CheckCaffeDataLayerSetUp(filename, clean_lines, linenum, error):
if ix >= 0 and (
line.find('void DataLayer<Dtype>::LayerSetUp') != -1 or
line.find('void ImageDataLayer<Dtype>::LayerSetUp') != -1 or
+ line.find('void LIBSVMDataLayer<Dtype>::LayerSetUp') != -1 or
line.find('void MemoryDataLayer<Dtype>::LayerSetUp') != -1 or
line.find('void WindowDataLayer<Dtype>::LayerSetUp') != -1):
error(filename, linenum, 'caffe/data_layer_setup', 2,
@@ -1622,6 +1623,7 @@ def CheckCaffeDataLayerSetUp(filename, clean_lines, linenum, error):
line.find('void Base') == -1 and
line.find('void DataLayer<Dtype>::DataLayerSetUp') == -1 and
line.find('void ImageDataLayer<Dtype>::DataLayerSetUp') == -1 and
+ line.find('void LIBSVMDataLayer<Dtype>::DataLayerSetUp') == -1 and
line.find('void MemoryDataLayer<Dtype>::DataLayerSetUp') == -1 and
line.find('void WindowDataLayer<Dtype>::DataLayerSetUp') == -1):
error(filename, linenum, 'caffe/data_layer_setup', 2,
なんか独自にLINTのチェッカーをインプリしているようだが、なんか例外的なものに追加しないといけないみたい。中読んでないので理解してない。
6. 親切にExampleでも追加しとく
IPython notebookで使い方のExampleを作った。
気付き・疑問
-
どこでtop, bottomのReshapeしてるんだっけ。→Netの設定ファイルでbottom: hoge top: fuga の数で決まる。 数が間違っていないかの確認はクラスメンバメソッドのExactほげとかをみて自動で確認してくれているはず
-
datum_size_とかのメンバ変数ってなんのために設定してんの?
-
複数のDataレイヤーを使うような状況でShuffleすると全部足並みが揃わない?揃わない。