Conditional Variational Autoencoder（CVAE）をTensorFlow 2系で実装する

## TL;DR
- オートエンコーダの一種である**条件付き変分オートエンコーダ**（Conditional Variational Autoencoder; **CVAE**）を、TensorFlowサンプルの改造で実装しました
- 実装したCVAEにMNISTデータを学習させて遊びました
- サンプルコードは以下のリポジトリで公開しています

[github.com/kn1cht/tensorflow_v2_cvae_sample](https://github.com/kn1cht/tensorflow_v2_cvae_sample)

<table>
  <tr>
    <td>sample-cvae-mnist.ipynb</td>
    <td>
        <a target="_blank" href="https://colab.research.google.com/drive/1J1JDVBdc9v_WKcHDrTIhCEVjsF43NZ0T?usp=sharing">Google Colab</a>
    </td>
    <td>
        <a target="_blank" href="https://github.com/kn1cht/tensorflow_v2_cvae_sample/blob/master/sample-cvae-mnist.ipynb">GitHub</a>
    </td>
  </tr>
  <tr>
    <td>sample-cvae-mnist-manifold.ipynb</td>
    <td>
        <a target="_blank" href="https://colab.research.google.com/drive/1q9UfVEADbecvejwKqWe59LDg2oSUiruz?usp=sharing">Google Colab</a>
    </td>
    <td>
        <a target="_blank" href="https://github.com/kn1cht/tensorflow_v2_cvae_sample/blob/master/sample-cvae-mnist-manifold.ipynb">GitHub</a>
    </td>
  </tr>
</table>

<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/360b66e5-2154-a33c-5ba0-65bb5aa548d0.png" alt="manifold-cvae-2.png" width=400>
生成した2D Manifold

## はじめに
**条件付き変分オートエンコーダ（CVAE）**は、ラベルに対応したデータを生成できる（半）教師ありの生成モデルです。
「[AutoEncoder, VAE, CVAEの比較　〜なぜVAEは連続的な画像を生成できるのか？](https://qiita.com/kenchin110100/items/7ceb5b8e8b21c551d69a)」に紹介されている通り、変分オートエンコーダ（VAE）にラベルを入力する処理を追加するだけで実現できます。

ChainerやPyTorch、TensorFlow 1系での実装例はネットで見つかりますが、TensorFlow 2系で書いた例はないようです。そこで、TensorFlow自体の勉強も兼ねて書いてみたものを記事化します。
実装にあたって**TensorFlow公式によるVAEのサンプルをなるべく変えずに改造**したため、変更部分を追うことで中身の理解の一助になれば幸いです。

## 環境
- Python 3.7.7
- tensorflow-gpu 2.0.0
- [CUDA](https://developer.nvidia.com/cuda-toolkit-archive) v10.0
- [cuDNN](https://developer.nvidia.com/cudnn) v7.6.5

## モデルの解説
すでに[分かりやすい解説](https://qiita.com/kenchin110100/items/7ceb5b8e8b21c551d69a)が存在するのでここではサラッと述べます。

### オートエンコーダ（AutoEncoder; AE）

もともとは**次元削減**を行う教師なし学習として提案されました。AEはEncoderとDecoderという2つのモデルからなり、Encoderが入力$\boldsymbol{x}$を$\boldsymbol{z}$に圧縮し、Decoderが$\boldsymbol{z}$から$\boldsymbol{x}$を再現しようとします。
中間で登場する$\boldsymbol{z}$は**潜在変数**と呼ばれ、データの特徴を少ない次元で表現したものと言えます。

AEは、入力をそのまま復元する以外にも、ノイズ除去や異常検知に応用できます。

### 変分オートエンコーダ（Variational Autoencoder; VAE）

確率分布を取り入れることで、**データ生成**にも使えるようにしたのがVAEです。Encoderで多変量ガウス分布のパラメータ$\mu$と$\sigma$を推定し、求まった確率分布から$\boldsymbol{z}$を作ります。$\boldsymbol{z}$が連続的な確率分布から得られるようになるので、データセットに存在しないデータをも生成できるようになるというわけです。

実際の学習では、誤差逆伝播ができるようReparametrization Trickという近似手法で$\boldsymbol{z}$を求めています。また、求めた分布と標準正規分布のKLダイバージェンス（カルバック・ライブラー・ダイバージェンス）を目的関数に含めることで、正則化を行います。

VAEで最大化する目的関数です。右辺第1項がDecoderで得られる出力の対数尤度の期待値、第2項が正則化項です。

```math
\mathcal{L}(\boldsymbol{x},\boldsymbol{z}) = \mathbb{E}_{q(\boldsymbol{z}|\boldsymbol{x})}[\log p(\boldsymbol{x}|\boldsymbol{z})] - D_{KL}[q(\boldsymbol{z}|\boldsymbol{x})||p(\boldsymbol{z})]
```

### 条件付き変分オートエンコーダ（Conditional Variational Autoencoder; CVAE）

Encoder、Decoderそれぞれにラベル$y$を入力として追加することで、**ラベルを指定してのデータ生成**を可能としたのがCVAEです。ラベルの情報を与えるので教師あり学習になりますが、工夫すれば全てにラベルを必要としない半教師あり学習としても使えるようです。

目的関数は以下のようにVAEから変わります。といっても、Encoder/Decoderが$y$を考慮するようになるだけであり、実装上はVAEの目的関数のままでOKです。

```math
\mathcal{L}(\boldsymbol{x},\boldsymbol{z},y) = \mathbb{E}_{q(\boldsymbol{z}|\boldsymbol{x},y)}[\log p(\boldsymbol{x}|\boldsymbol{z},y)] - D_{KL}[q(\boldsymbol{z}|\boldsymbol{x},y)||p(\boldsymbol{z}|y)]
```

## CVAEの実装

それではCVAEを実装します。[元論文](https://arxiv.org/abs/1406.5298)によるとVAE（M1モデル）とCVAE（M2モデル）を組み合わせることで半教師あり学習も可能ですが、本記事ではそこまではせず全データにラベルを対応させて学習します。

コード全体を以下のリポジトリに公開しています。

- [github.com/kn1cht/tensorflow_v2_cvae_sample](https://github.com/kn1cht/tensorflow_v2_cvae_sample)

### TensorFlow公式VAEサンプル
VAEについては、TensorFlowの公式チュートリアルにサンプルが収録されています。

- [Convolutional Variational Autoencoder  |  TensorFlow Core](https://www.tensorflow.org/tutorials/generative/cvae#import_tensorflow_and_other_libraries)


**Google Colaboratoryで公開されている**ので、ポチッと実行すればいい感じに動きます。

- [cvae.ipynb - Colaboratory](https://colab.research.google.com/github/tensorflow/docs/blob/master/site/en/tutorials/generative/cvae.ipynb)

注意したいのは、ここではConvolutional Variational AutoencoderをCVAEと呼んでいて、**本記事で説明してきたCVAEとは別物**ということです。こちらのサンプルのモデルは、畳み込み層が入っているというだけで、普通のVAEです。

このMNISTを学習してくれるVAEを改造し、Conditional VAEを実現します。

### VAEからCVAEへ
上記のサンプルコードからモデルを定義している部分を抜き出したものを[vae.py](https://github.com/kn1cht/tensorflow_v2_cvae_sample/blob/master/vae.py)、そこから作成したCVAEのコードを[cvae.py](https://github.com/kn1cht/tensorflow_v2_cvae_sample/blob/master/cvae.py)としてリポジトリに置いています。

差分を見たほうが分かりやすいので、以降は[両者のdiff](https://github.com/kn1cht/tensorflow_v2_cvae_sample/blob/master/diff-vae-cvae.diff)を掲載しながら説明していきます。

#### CVAE.__init__()

```diff
--- vae.py
+++ cvae.py

-  def __init__(self, latent_dim):
+  def __init__(self, latent_dim, label_size):
     super(CVAE, self).__init__()
-    self.latent_dim = latent_dim
+    (self.latent_dim, self.label_size) = (latent_dim, label_size)
     self.encoder = tf.keras.Sequential(
         [
-            tf.keras.layers.InputLayer(input_shape=(28, 28, 1)),
+            tf.keras.layers.InputLayer(input_shape=(28, 28, label_size + 1)),
             tf.keras.layers.Conv2D(
                 filters=32, kernel_size=3, strides=(2, 2), activation='relu'),
             tf.keras.layers.Conv2D(
@@ -30,7 +31,7 @@ class CVAE(tf.keras.Model):

     self.decoder = tf.keras.Sequential(
         [
-            tf.keras.layers.InputLayer(input_shape=(latent_dim,)),
+            tf.keras.layers.InputLayer(input_shape=(latent_dim + label_size,)),
             tf.keras.layers.Dense(units=7*7*32, activation=tf.nn.relu),
             tf.keras.layers.Reshape(target_shape=(7, 7, 32)),
             tf.keras.layers.Conv2DTranspose(
```

まずはモデルの定義部分です。ラベル$y$の種類（MNISTなら10種類ですね）を`label_size`として、Encoder/Decoderそれぞれ入力のサイズを`label_size`分だけ増やしています。
これで、One-hot表現に変換したラベルを入力と結合できるようになります。

#### CVAE.__sample__()

```diff
   @tf.function
-  def sample(self, eps=None):
+  def sample(self, eps=None, y=None):
     if eps is None:
       eps = tf.random.normal(shape=(100, self.latent_dim))
-    return self.decode(eps, apply_sigmoid=True)
+    return self.decode(eps, y, apply_sigmoid=True)
```

`sample()`は、潜在変数とラベルを受け取ってデータを生成する処理です。

#### CVAE.__encode__()

```diff
-  def encode(self, x):
-    mean, logvar = tf.split(self.encoder(x), num_or_size_splits=2, axis=1)
+  def encode(self, x, y):
+    n_sample = x.shape[0]
+    image_size = x.shape[1:3]
+
+    y_onehot = tf.reshape(tf.one_hot(y, self.label_size), [n_sample, 1, 1, self.label_size]) # 1 x 1 x label_size
+    k = tf.ones([n_sample, *image_size, 1]) # {image_size} x 1
+    h = tf.concat([x, k * y_onehot], 3) # {image_size} x (1 + label_size)
+
+    mean, logvar = tf.split(self.encoder(h), num_or_size_splits=2, axis=1)
     return mean, logvar
```

Encoderに入力を読み込ませる処理です。まず、ラベル`y`をOne-hot表現`y_onehot`に変換します。
それとは別に、形状が「画像サイズ（MNISTなら28×28）×1」で要素が全て1のテンソル`k`を作っておきます。
`k * y_onehot`を計算すると、broadcast機能によって「28×28×label_size」となり`x`と結合できる形になります。

（この部分は[ysasaki6023氏の実装](https://github.com/ysasaki6023/conditionalVAE/blob/v1.0/vae.py#L151-L155)を参考にさせていただきました。もっと雑にxとyを繋げてしまっても動きはするようです）

#### CVAE.__decode__()

```diff
-  def decode(self, z, apply_sigmoid=False):
-    logits = self.decoder(z)
+  def decode(self, z, y=None, apply_sigmoid=False):
+    n_sample = z.shape[0]
+    if not y is None:
+      y_onehot = tf.reshape(tf.one_hot(y, self.label_size), [n_sample, self.label_size]) # label_size
+      h = tf.concat([z, y_onehot], 1) # latent_dim + label_size
+    else:
+      h = tf.concat([z, tf.zeros([n_sample, self.label_size])], 1)  # latent_dim + label_size
+    logits = self.decoder(h)
     if apply_sigmoid:
       probs = tf.sigmoid(logits)
       return probs
```

Decoderにも、同様に`z`と`y_onehot`を繋げて渡します。`y`がNoneかどうかで場合分けしているのは、ラベルを渡さなくてもデータ生成を試せるようにするためです。
しかし、ラベルなしでの学習をしなかったので、結局よく分からない画像しか出てきませんでした……。

#### compute_loss()

```diff
-def compute_loss(model, x):
-  mean, logvar = model.encode(x)
+def compute_loss(model, xy):
+  (x, y) = xy # x: image, y: label
+  mean, logvar = model.encode(x, y)
   z = model.reparameterize(mean, logvar)
-  x_logit = model.decode(z)
+  x_logit = model.decode(z, y)
   cross_ent = tf.nn.sigmoid_cross_entropy_with_logits(logits=x_logit, labels=x)
   logpx_z = -tf.reduce_sum(cross_ent, axis=[1, 2, 3])
   logpz = log_normal_pdf(z, 0., 0.)
```

学習時の目的関数の処理です。上述の通り目的関数の実装はVAEから特に変わらないため、引数に`y`が増えるだけです。

#### train_step()


```diff
 @tf.function
-def train_step(model, x, optimizer):
+def train_step(model, xy, optimizer):
   """Executes one training step and returns the loss.

   This function computes the loss and gradients, and uses the latter to
   update the model's parameters.
   """
   with tf.GradientTape() as tape:
-    loss = compute_loss(model, x)
+    loss = compute_loss(model, xy)
   gradients = tape.gradient(loss, model.trainable_variables)
   optimizer.apply_gradients(zip(gradients, model.trainable_variables))
```

学習を1ステップ回す処理です。

### 入力データセットの準備

TensorFlowのデータセット機能（`tf.data.Dataset`）で、MNISTの**画像とラベルがペアになった入力**を作ります。
筆者はTensorFlow初心者なので、公式サンプルを見て「この通りにtrain_datasetをシャッフルしてしまったら画像とラベルの対応が崩れるよな……？」とか悩んでググっていました。そんなニーズを満たす機能は当然用意されていて、こちらのチュートリアルで懇切丁寧に解説されています。

- [tf.dataを使って画像をロードする  |  TensorFlow Core](https://www.tensorflow.org/tutorials/load_data/images?hl=ja)

```python
train_dataset_x = tf.data.Dataset.from_tensor_slices(x_train)
test_dataset_x = tf.data.Dataset.from_tensor_slices(x_test)
print(train_dataset_x, test_dataset_x)

train_dataset_y= tf.data.Dataset.from_tensor_slices(y_train)
test_dataset_y = tf.data.Dataset.from_tensor_slices(y_test)
print(train_dataset_y, test_dataset_y)
```

まずは、画像とラベルを**シャッフルせずに**データセットへ変換します。

```python
train_dataset_xy = tf.data.Dataset.zip((train_dataset_x, train_dataset_y))
train_dataset_xy = train_dataset_xy.shuffle(train_size).batch(batch_size)
test_dataset_xy = tf.data.Dataset.zip((test_dataset_x, test_dataset_y))
test_dataset_xy = test_dataset_xy.shuffle(train_size).batch(batch_size)
print(train_dataset_xy, test_dataset_xy)
```

それぞれのデータセットができたら、`tf.data.Dataset.zip()`でまとめると**`(画像, ラベル)`のペア**になります。ここからシャッフルやミニバッチ化を行っても、両者の対応は崩れません。イテレーションすると、`(画像のテンソル,ラベルのテンソル)`のタプルが出てくるので、一緒に使うこともそれぞれ使うことも可能です。

### CVAEで遊ぶ

CVAEができたので、MNISTデータを学習させて遊んでみました。
この節のコードは、リポジトリ及びGoogle Colaboratoryで公開しています。Google Colabの方は、実際に動かしていただくこともできます。

<table>
  <tr>
    <td>sample-cvae-mnist.ipynb</td>
    <td>
        <a target="_blank" href="https://colab.research.google.com/drive/1J1JDVBdc9v_WKcHDrTIhCEVjsF43NZ0T?usp=sharing">Google Colab</a>
    </td>
    <td>
        <a target="_blank" href="https://github.com/kn1cht/tensorflow_v2_cvae_sample/blob/master/sample-cvae-mnist.ipynb">GitHub</a>
    </td>
  </tr>
  <tr>
    <td>sample-cvae-mnist-manifold.ipynb</td>
    <td>
        <a target="_blank" href="https://colab.research.google.com/drive/1q9UfVEADbecvejwKqWe59LDg2oSUiruz?usp=sharing">Google Colab</a>
    </td>
    <td>
        <a target="_blank" href="https://github.com/kn1cht/tensorflow_v2_cvae_sample/blob/master/sample-cvae-mnist-manifold.ipynb">GitHub</a>
    </td>
  </tr>
</table>


#### ハイパーパラメータ
TensorFlow公式サンプルでは、潜在変数全体を2次元画像で表す（2D manifold）ために潜在変数の次元（`latent_dim`）を2としていました。ただ、[AutoEncoder, VAE, CVAEの比較　〜なぜVAEは連続的な画像を生成できるのか？](https://qiita.com/kenchin110100/items/7ceb5b8e8b21c551d69a)の実験によれば次元数の大きいほうが鮮明な結果になっているので。最後のmanifold以外は**潜在変数を64次元**にします。

訓練・テストにはMNISTデータ全体（それぞれ60000, 10000）を使い、全ての訓練データに正解ラベルを付けて学習させました。エポック数は100（manifoldの方は50）、ミニバッチサイズは32としました。

#### 画像の復元
MNISTの先頭から32枚の画像を復元させてみます。

![mnist32.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/5c534e3e-c540-7f99-22b3-929ebac3eb07.png)

まずは**画像及び正しいラベル**を与えてDecoderにかけてみます。

![mnist32-cvae.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/882c3e5f-275d-63e4-fcc1-12e9112f03bd.png)

細部はぼやけたものの、自然な数字が復元されました。

次に、32枚全てに**「8」のラベル**を与えてみます。ここで扱う32枚の入力に「8」のデータは含まれていないので、データセットに存在しないデータを生成することになります。

![mnist32-cvae-8.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/64c91084-7404-c0d3-c4c3-271619a5a563.png)

一部破綻してしまいましたが、半分くらいは8として許せる文字になっていそうです。**CVAEが指定したラベルのデータを生成できる**ことを確認できました。

#### 筆跡の連続変化

VAEシリーズの特徴として、**連続的なデータを生成できる**ことがあります。VAEであれば、例えば「0」の潜在変数から「1」の潜在変数までを連続的に変化させることで、徐々に別の数字に変化する画像を作れます。

![cont-vae.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/1d19fbd8-55ce-8e22-0cd8-875e5d91553c.png)

CVAEでは、潜在変数からはラベルの情報が取り除かれ、**筆跡の違いを表現するようになる**と言われています。そこで、ラベルを固定して潜在変数を連続変化させて、筆跡が連続変化する画像を作ってみます。
入力は、前節と同様MNISTの先頭32枚から選びました。

![cont-cvae-4.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/007c2804-e7b2-7009-e8fd-e21af8076c04.png)

「線の太い0」から「線の細い0」までの潜在変数と、「4」のラベルで生成した連続画像です。下に行くにつれて線がだんだん細くなり、文字の縦横比も変化しました。

![cont-cvae-6.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/ee702586-61db-2e72-44e4-461c630279a5.png)

こちらは「右に傾いた1」から「左に傾いた3」までの潜在変数と「6」のラベルで生成した連続画像です。数字の傾きが徐々に変化するのが分かります。

#### 2D Manifold
2次元の潜在変数の空間全体から画像を生成し、縦横に並べた画像は**2D Manifold**と呼ばれます。VAEならこのような画像になります。

![manifold-vae.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/7f484afc-9223-8f87-73b5-b47658f0371f.png)

ラベルをいくつか指定してCVAEの2D Manifoldを生成させてみます。なお、潜在空間内の配置方向は学習のたびに変わるので、画像の向きに意味はありません。

![manifold-cvae-4.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/541ca688-13e7-8177-fa26-81e8765371fa.png)

「4」を指定した時の結果です。潜在変数が、文字の縦横比や傾きの情報を持っていることが分かります。

![manifold-cvae-2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/150557/360b66e5-2154-a33c-5ba0-65bb5aa548d0.png)

個人的に面白かったのが「2」の結果です。**数字の下の部分をクルッと丸めて書くかどうか**が分かれています。
CVAEでは潜在空間からラベルの情報が取り除かれ、筆跡の情報を保持するようになることが確認できました。

## おわりに

本記事では、TensorFlow 2系のVAEサンプルを改変し、CVAEを実装しました。また、MNISTを学習したCVAEで画像の復元や連続変化などを試しました。

TensorFlow初心者なので、確実に動くサンプルコードを参考にしながら実装できたのはとても助かりました。書き方もそれなりに理解できた気がするので、今後はいろいろなデータを学習させてみることにします。

## 参考記事
- [Conditional variational AutoEncoderをTensorflowで実装する - Qiita](https://qiita.com/ysasaki6023/items/119ed018d9f40bb05df9)
    - TensorFlow 1系によるCVAEの実装報告です。実装の留意点が多数解説されています。
- [AutoEncoder, VAE, CVAEの比較　〜なぜVAEは連続的な画像を生成できるのか？](https://qiita.com/kenchin110100/items/7ceb5b8e8b21c551d69a)
    - オートエンコーダの基礎からVAE, CVAEまでが図入りで分かりやすく説明されています。潜在変数の次元を変えての復元や連続変化の実験結果も掲載されています。
- [深層生成モデルを巡る旅(2): VAE - Qiita](https://qiita.com/shionhonda/items/e2cf9fe93ae1034dd771)
    - 目的関数の式も載っている詳しめの記事です。β-VAE、VQ-VAEなどのさらに新しい成果も紹介されています。