DCGANで手書き文字を生成するチュートリアル(メモ)

tensorflow->チュートリアル->Generative modelsの[DCGAN](https://github.com/tensorflow/tensorflow/blob/r1.13/tensorflow/contrib/eager/python/examples/generative_examples/dcgan.ipynb)をやったので要約。

**tf.kerasとeager executionを使って、google colabで実行している。**
理論的なことにはほとんど触れない。

元記事はTensorFlow Authorsらによる。
>Copyright 2018 The TensorFlow Authors.
Licensed under the Apache License, Version 2.0 (the "License").


##GANとは
生成モデルを作るフレームワーク。
データ生成する**Generator**(以下G)と、訓練データまたは生成されたデータから、データが来た確率を推定する**Discriminator**(以下D)を敵対的に同時訓練する。**D**が本物か偽物か識別できなくなるまで、**G**は少しずつデータ生成がうまくなる。
<img src=https://qiita-image-store.s3.amazonaws.com/0/296108/dd1e3687-f81b-1356-62fd-4e96a50424d5.png width=600>

ここではMNISTでこのプロセスを示す。
50epoch訓練したGの生成した画像を時系列で示す。時間が経つごとに訓練画像と見分けがつかなくなる。

GANについてはMITの[Intro to Deep Learning](http://introtodeeplearning.com/)コースをおすすめする。ディープ生成モデルについても[レクチャー](https://www.youtube.com/watch?v=JVb54xhEw6Y&feature=youtu.be)がある。(スライドもリンクしてあったがリンク切れ)
<img src=https://qiita-image-store.s3.amazonaws.com/0/296108/0c0f2d46-7299-4d1a-55f1-5bdb7f28994b.gif>


```python
#imageioは訓練のgif画像のため 
!pip install imageio
```
###import Tensorflow, `eager execution`の有効化

```python
import tensorflow as tf
tf.enable_eager_execution()

import glob
import imageio
import matplotlib.pyplot as plt
import numpy as np
import os
import PIL
import time

from IPython import display
```

###データセットロード
GとDはMNISTで訓練する。GはMNISTに似た画像を生成する。

```python

(train_images, train_labels), (_, _) = tf.keras.datasets.mnist.load_data()
```

```python

train_images = train_images.reshape(train_images.shape[0], 28, 28, 1).astype('float32')
train_images = (train_images - 127.5) / 127.5 # 画像は正規化して 値を[-1, 1]に収める
```
```python

BUFFER_SIZE = 60000
BATCH_SIZE = 256
```

###バッチの作成、データセットのシャッフルにに`tf.data`を使う

```python
train_dataset = tf.data.Dataset.from_tensor_slices(train_images).shuffle(BUFFER_SIZE).batch(BATCH_SIZE)
```

##モデルを作る
`tf.keras`の[Sequential API](https://www.tensorflow.org/guide/keras#sequential_model)を使う。

###Generator
GはDを騙せるような画像を作る。アーキテクチャは[Conv2DTranspose](https://www.tensorflow.org/api_docs/python/tf/keras/layers/Conv2DTranspose)(Upsampling)レイヤを使う。
ほしい画像サイズである28x28x1にするために全結合からスタートして２回upsampleする。幅・高さは増加させ、奥行きは減少させていく。活性化関数に[Leaky ReLU](https://www.tensorflow.org/api_docs/python/tf/keras/layers/LeakyReLU)を使うが、最後のみ`tanh`にする。

```python
def make_generator_model():
    model = tf.keras.Sequential()
    model.add(tf.keras.layers.Dense(7*7*256, use_bias=False, input_shape=(100,)))
    model.add(tf.keras.layers.BatchNormalization())
    model.add(tf.keras.layers.LeakyReLU())
      
    model.add(tf.keras.layers.Reshape((7, 7, 256)))
    assert model.output_shape == (None, 7, 7, 256) # Note: None は(指定しない意味で、自動的に)batch sizeの値になる
    
    model.add(tf.keras.layers.Conv2DTranspose(128, (5, 5), strides=(1, 1), padding='same', use_bias=False))
    assert model.output_shape == (None, 7, 7, 128)  
    model.add(tf.keras.layers.BatchNormalization())
    model.add(tf.keras.layers.LeakyReLU())

    model.add(tf.keras.layers.Conv2DTranspose(64, (5, 5), strides=(2, 2), padding='same', use_bias=False))
    assert model.output_shape == (None, 14, 14, 64)    
    model.add(tf.keras.layers.BatchNormalization())
    model.add(tf.keras.layers.LeakyReLU())

    model.add(tf.keras.layers.Conv2DTranspose(1, (5, 5), strides=(2, 2), padding='same', use_bias=False, activation='tanh'))
    assert model.output_shape == (None, 28, 28, 1)
  
    return model
```

###Discriminator
画像が本物かどうか判別する。通常のCNNベース分類器に似ている。

```python

def make_discriminator_model():
    model = tf.keras.Sequential()
    #出力チャネル数、カーネルサイズ、ストライド、パディング
    model.add(tf.keras.layers.Conv2D(64, (5, 5), strides=(2, 2), padding='same'))
    model.add(tf.keras.layers.LeakyReLU())
    model.add(tf.keras.layers.Dropout(0.3))
      
    model.add(tf.keras.layers.Conv2D(128, (5, 5), strides=(2, 2), padding='same'))
    model.add(tf.keras.layers.LeakyReLU())
    model.add(tf.keras.layers.Dropout(0.3))
       
    model.add(tf.keras.layers.Flatten())
    model.add(tf.keras.layers.Dense(1))
     
    return model
```

```python

generator = make_generator_model()
discriminator = make_discriminator_model()
```

##誤差関数とoptimizerの定義
###Generator
Gの誤差関数は生成画像とarray of onesのシグモイドクロスエントロピー。
`tf.ones_like()`は引数のテンソルと同じshape, typeで中身が全て1のテンソルを返す。

```python

def generator_loss(generated_output):
    return tf.losses.sigmoid_cross_entropy(tf.ones_like(generated_output), generated_output)
```

###Discriminator
Dの誤差関数は２つ引数を取る。一つは本物画像、もう一つは生成画像。計算は次の通り。

1. 真の画像とarray of onesとのシグモイドクロスエントロピーを計算する。これは`real_loss`と呼ぶ。
2. 生成画像とarray of zerosのシグモイドクロスエントロピーを計算する。これは`generated_loss`と呼ぶ。
3. `generated_loss`と`real_loss`の和である`total_loss`を計算する。

```python
# 引数のreal_output, generated_outputはいずれもdiscriminatorを通した後の値。
# generatorの生成したoutputではない。一瞬びっくりした。
def discriminator_loss(real_output, generated_output):
    # [1,1,...,1] with real output since it is true and we want our generated examples to look like it
    real_loss = tf.losses.sigmoid_cross_entropy(multi_class_labels=tf.ones_like(real_output), logits=real_output)

    # [0,0,...,0] with generated images since they are fake
    generated_loss = tf.losses.sigmoid_cross_entropy(multi_class_labels=tf.zeros_like(generated_output), logits=generated_output)

    total_loss = real_loss + generated_loss

    return total_loss
```
２つのネットワークを別々に訓練するのでGとDのオプティマイザは別物。

```python
generator_optimizer = tf.train.AdamOptimizer(1e-4)
discriminator_optimizer = tf.train.AdamOptimizer(1e-4)
```
Checkpoints (**Object-based saving**)
※[こちら](https://stackoverflow.com/questions/49774657/tensorflow-eager-name-based-vs-object-based-saving)によると**Object-based saving**は従来のname based(変数名だけでcheckpointに保存される値を管理する)とは異なり、オブジェクトのdependency graphをcheckpointに一緒に保存し、プログラムの変更や複数checkpointの使用にロバストになるらしい。

```python
checkpoint_dir = './training_checkpoints'
checkpoint_prefix = os.path.join(checkpoint_dir, "ckpt")
checkpoint = tf.train.Checkpoint(generator_optimizer=generator_optimizer,
                                 discriminator_optimizer=discriminator_optimizer,
                                 generator=generator,
                                 discriminator=discriminator)
```

##訓練の設定
###パラメータの定義

```python
EPOCHS = 50
noise_dim = 100
num_examples_to_generate = 16

#訓練の経過を見るための固定入力ランダムベクトル
random_vector_for_generation = tf.random_normal([num_examples_to_generate,
                                                 noise_dim])
```

###訓練方法
Gにはランダムベクトルを入力する。MNISTっぽくなるようにする。DはMNISTの本物と、Gの生成画像を入力。

```python

def train_step(images):
   # 正規分布に従う入力ベクトルを作る
      noise = tf.random_normal([BATCH_SIZE, noise_dim])
      
      with tf.GradientTape() as gen_tape, tf.GradientTape() as disc_tape:
        generated_images = generator(noise, training=True)
      
        real_output = discriminator(images, training=True)
        generated_output = discriminator(generated_images, training=True)
         
        gen_loss = generator_loss(generated_output)
        disc_loss = discriminator_loss(real_output, generated_output)
        
      gradients_of_generator = gen_tape.gradient(gen_loss, generator.variables)
      gradients_of_discriminator = disc_tape.gradient(disc_loss, discriminator.variables)
      
      generator_optimizer.apply_gradients(zip(gradients_of_generator, generator.variables))
      discriminator_optimizer.apply_gradients(zip(gradients_of_discriminator, discriminator.variables))
```
ColabのTesla K80 1台で1epochあたり３０秒だったらしい。(2018/10時点で)

Eager executionはグラフ定義に比べて最適化できないので遅くなる場合がある。[tf.contrib.eager.defun](https://www.tensorflow.org/api_docs/python/tf/contrib/eager/defun)でグラフにコンパイルすると最大20秒/epochくらい速くなる、とのこと。

```python
train_step = tf.contrib.eager.defun(train_step)
```

```python
def train(dataset, epochs):  
  for epoch in range(epochs):
    start = time.time()
    
    for images in dataset:
      train_step(images)

    display.clear_output(wait=True)
    generate_and_save_images(generator,
                               epoch + 1,
                               random_vector_for_generation)
    
    # saving (checkpoint) the model every 15 epochs
    if (epoch + 1) % 15 == 0:
      checkpoint.save(file_prefix = checkpoint_prefix)
    
    print ('Time taken for epoch {} is {} sec'.format(epoch + 1,
                                                      time.time()-start))
  # generating after the final epoch
  display.clear_output(wait=True)
  generate_and_save_images(generator,
                           epochs,
                           random_vector_for_generation)
```

###Generate and save images関数

```python
def generate_and_save_images(model, epoch, test_input):
  # 推定時にbatchnormは訓練しないので、Falseにする
  predictions = model(test_input, training=False)

  fig = plt.figure(figsize=(4,4))
  
  for i in range(predictions.shape[0]):
      plt.subplot(4, 4, i+1)
      plt.imshow(predictions[i, :, :, 0] * 127.5 + 127.5, cmap='gray')
      plt.axis('off')
        
  plt.savefig('image_at_epoch_{:04d}.png'.format(epoch))
  plt.show()
```

##訓練する
上で定義した`train()`関数で開始。
GANの訓練は扱いづらい。GとDが互いに拮抗するようにして、どちらかが強くなりすぎないように。
訓練の最初は生成イメージがノイズっぽいが、訓練が進むとどんどんリアルになる。50epochぐらいでMNISTの数字っぽくなる。


```python
%%time
train(train_dataset, EPOCHS)
```
※`%%time`はjupyterでセルの計測時間を測るセルマジック

###最新のcheckpointをリストアする

```python
checkpoint.restore(tf.train.latest_checkpoint(checkpoint_dir))
```

##生成画像
訓練が終わったら画像生成しよう!plotして完成だ！

```python
# 単体画像
def display_image(epoch_no):
  return PIL.Image.open('image_at_epoch_{:04d}.png'.format(epoch_no))
```

```python
display_image(EPOCHS)
```

###保存された画像全部のGIFを生成する
訓練中に保存された全ての画像を使ってアニメーションGIFを作る。`imageio`を使う。

```python
with imageio.get_writer('dcgan.gif', mode='I') as writer:
  filenames = glob.glob('image*.png')
  filenames = sorted(filenames)
  last = -1
  for i,filename in enumerate(filenames):
    frame = 2*(i**0.5)
    if round(frame) > round(last):
      last = frame
    else:
      continue
    image = imageio.imread(filename)
    writer.append_data(image)
  image = imageio.imread(filename)
  writer.append_data(image)
    
# this is a hack to display the gif inside the notebook
os.system('cp dcgan.gif dcgan.gif.png')
```

表示

```python
display.Image(filename="dcgan.gif.png")
```

###アニメーションGIFをダウンロードする
```python
from google.colab import files
files.download('dcgan.gif')
```

##GANについて学ぶ
次のステップとして別のデータセットで実験したいかもしれない。例えば [**Large-scale Celeb Faces Attributes (CelebA)**](https://www.kaggle.com/jessicali9530/celeba-dataset/home)

GANについては、

* 先述のMITのレクチャーまたはStanford's CS231nの[このレクチャー](http://cs231n.stanford.edu/slides/2018/cs231n_2018_lecture12.pdf)
* [CVPR 2018 Tutorial on GANs](https://sites.google.com/view/cvpr2018tutorialongans/)と[NIPS 2016 Tutorial: Generative Adversarial Networks](https://arxiv.org/abs/1701.00160)もおすすめ