2019-01-24

機械学習のExampleから覚えるPython(class:コンストラクタ)

Python

今までPythonを感覚的に使っていたので、改めて文法を知ろうかなと。
その際にいま流行りの機械学習(深層学習)のExampleを例にすると
わかりやすいのかなと思ったので書いてみる。

※基本的には Python3.x系のつもりで記載してます

Example

https://www.tensorflow.org/tutorials/ に記載されている

import tensorflow as tf
mnist = tf.keras.datasets.mnist

(x_train, y_train),(x_test, y_test) = mnist.load_data()
x_train, x_test = x_train / 255.0, x_test / 255.0

model = tf.keras.models.Sequential([
  tf.keras.layers.Flatten(),
  tf.keras.layers.Dense(512, activation=tf.nn.relu),
  tf.keras.layers.Dropout(0.2),
  tf.keras.layers.Dense(10, activation=tf.nn.softmax)
])
model.compile(optimizer='adam',
              loss='sparse_categorical_crossentropy',
              metrics=['accuracy'])

model.fit(x_train, y_train, epochs=5)
model.evaluate(x_test, y_test)

※本記事記載の時点のコードです。

class

model = tf.keras.models.Sequential([
  tf.keras.layers.Flatten(),
  tf.keras.layers.Dense(512, activation=tf.nn.relu),
  tf.keras.layers.Dropout(0.2),
  tf.keras.layers.Dense(10, activation=tf.nn.softmax)
])

tf.keras.models.Sequential は classと呼ばれるもので定義されています。

実際のコードはこちらにあります。

@keras_export('keras.models.Sequential', 'keras.Sequential')
class Sequential(Model):

さて、前回の記事では Sequentialクラス Modelは継承(基底クラス)というお話でした。
では、Exampleコードに書かれている

  tf.keras.layers.Flatten(),
  tf.keras.layers.Dense(512, activation=tf.nn.relu),
  tf.keras.layers.Dropout(0.2),
  tf.keras.layers.Dense(10, activation=tf.nn.softmax)

の部分はどこにあたるのかを今回見ていきたいと思います。

コンストラクタ

Pythonでは、特殊な関数があります。
その一つがコンストラクタ: __init()__になります。
クラスがインスタンスされた際に自動で呼び出されます。

では、実際の実装のほうを見てみたいと思います。

  def __init__(self, layers=None, name=None):
    super(Sequential, self).__init__(name=name)
    self.supports_masking = True
    self._build_input_shape = None
    self._compute_output_and_mask_jointly = True

    self._layer_call_argspecs = {}

    # Add to the model any layers passed to the constructor.
    if layers:
      for layer in layers:
        self.add(layer)

実際のコードはこちらにあります。

self はクラス自身を指すので、引数としては無視してください。
では、クラスをインスタンス(宣言)時に引数として渡していた
tf.keras.layers.*** はどの引数に該当するかというと layers になります。

    # Add to the model any layers passed to the constructor.
    if layers:
      for layer in layers:
        self.add(layer)

つまり、コンストラクタ(初期化)で行っている処理は
layers が存在していれば(Noneでなければ)、layers の配列数だけ
クラス自身のadd関数を呼び出すです。

add関数が何をしているかは確認してもらえればと思います。

デコンストラクタ

クラスが削除される際に自動で呼び出されます。
デコンストラクタ: __del()__になります。

Sequentialクラスには実装がありませんね。
必要に応じて実装すればよいかと思いますが、あまり見た記憶がありません。

おまけ

TensorFlow公式ページでは、Kerasによる書き方がいくつか紹介されています。
独自のModelやLayerの書き方などもありますので、参考にすると良いかと思います。

https://www.tensorflow.org/guide/keras

今回のコンストラクタの話でいうと、このような書き方も記載されています。

model = tf.keras.Sequential()
model.add(layers.Dense(16, activation='relu', input_shape=(10,)))
model.add(layers.Dense(1, activation='sigmoid'))

引数なしで Sequentialクラスをインスタンスし、次行で add関数で Layerを追加している書き方になります。

2019-01-23

機械学習のExampleから覚えるPython(class:継承)

Python

※基本的には Python3.x系のつもりで記載してます

Example

https://www.tensorflow.org/tutorials/ に記載されている

import tensorflow as tf
mnist = tf.keras.datasets.mnist

(x_train, y_train),(x_test, y_test) = mnist.load_data()
x_train, x_test = x_train / 255.0, x_test / 255.0

model = tf.keras.models.Sequential([
  tf.keras.layers.Flatten(),
  tf.keras.layers.Dense(512, activation=tf.nn.relu),
  tf.keras.layers.Dropout(0.2),
  tf.keras.layers.Dense(10, activation=tf.nn.softmax)
])
model.compile(optimizer='adam',
              loss='sparse_categorical_crossentropy',
              metrics=['accuracy'])

model.fit(x_train, y_train, epochs=5)
model.evaluate(x_test, y_test)

※本記事記載の時点のコードです。

class

model = tf.keras.models.Sequential([
  tf.keras.layers.Flatten(),
  tf.keras.layers.Dense(512, activation=tf.nn.relu),
  tf.keras.layers.Dropout(0.2),
  tf.keras.layers.Dense(10, activation=tf.nn.softmax)
])

tf.keras.models.Sequential は classと呼ばれるもので定義されています。

実際のコードはこちらにあります。

@keras_export('keras.models.Sequential', 'keras.Sequential')
class Sequential(Model):

継承

class Sequential(Model):

このSequentialクラスは Modelクラスを継承しています。
Modelを「基底クラス」、Sequentialを「派生クラス」と言ったりします。

やっていることは、シンプルで Sequential = Model + Sequential独自という形で
Modelの関数や変数を Sequentialでも使えます。

Exampleで記述している

model.compile(optimizer='adam',
              loss='sparse_categorical_crossentropy',
              metrics=['accuracy'])

model.fit(x_train, y_train, epochs=5)
model.evaluate(x_test, y_test)

こちらの compileやfit、evaluate 関数は Sequentialのクラスコード内には記述がありません。
実際に記述されているのは Model にあります。

確認したい方はこちらを参照してください。

多重継承

基底クラスを複数宣言できるというお話です。

class DerivedClassName(Base1, Base2, Base3):
    <statement-1>
    .
    .
    .
    <statement-N>

参考

9.クラス — Python 3.7.2 ドキュメント

さて、あとはSequentialクラスをインスタンスしている部分(初期化)と
演算子(Exampleでは x_train / 255.0 )さえ理解すれば題目の
Exampleコードはすべて理解できたことになりますね！

2019-01-22

機械学習のExampleから覚えるPython(関数の引数)

Python

※基本的には Python3.x系のつもりで記載してます

Example

https://www.tensorflow.org/tutorials/ に記載されている

import tensorflow as tf
mnist = tf.keras.datasets.mnist

(x_train, y_train),(x_test, y_test) = mnist.load_data()
x_train, x_test = x_train / 255.0, x_test / 255.0

model = tf.keras.models.Sequential([
  tf.keras.layers.Flatten(),
  tf.keras.layers.Dense(512, activation=tf.nn.relu),
  tf.keras.layers.Dropout(0.2),
  tf.keras.layers.Dense(10, activation=tf.nn.softmax)
])
model.compile(optimizer='adam',
              loss='sparse_categorical_crossentropy',
              metrics=['accuracy'])

model.fit(x_train, y_train, epochs=5)
model.evaluate(x_test, y_test)

※本記事記載の時点のコードです。

関数の引数

前回機械学習のExampleから覚えるPython(関数呼び出し)にて、load_data 関数の引数 pathが呼び出し時に省略されていることが確認できました。

関数の引数については3つの指定ができます。

dafaultによる省略
引数を入力(引数名無し)
引数名を指定

defaultによる省略

関数定義側で、default値が設定している場合に
呼び出し側が default値で良い場合省略することができます。

関数定義側

def load_data(path='mnist.npz'):

呼び出し側

(x_train, y_train),(x_test, y_test) = mnist.load_data()

path は mnist.npzの値で処理されます。

引数を入力(引数名無し)

model.fit(x_train, y_train, epochs=5)

このコードを見てみます。
定義側はこのようになってます。

関数定義側

  def fit(self,
          x=None,
          y=None,
          batch_size=None,
          epochs=1,
          verbose=1,
          callbacks=None,
          validation_split=0.,
          validation_data=None,
          shuffle=True,
          class_weight=None,
          sample_weight=None,
          initial_epoch=0,
          steps_per_epoch=None,
          validation_steps=None,
          validation_freq=1,
          max_queue_size=10,
          workers=1,
          use_multiprocessing=False,
          **kwargs):

self は一旦無視していただいて、x_train, y_train が fit関数の
どの引数にあたるかというと、順番に設定しています。
つまり、以下のようになります。

#         x=x_train, y=y_train
model.fit(x_train, y_train, epochs=5)

引数名を指定

先ほどのコードの epochsの設定が該当します。

model.fit(x_train, y_train, epochs=5)

fit関数で定義されている epochsを指定して 5という値を入力しています。

可変長引数

関数の定義では、可変長引数 を定義することができます。
fit関数でも最後の引数に出てきていた **kwargsが該当します。

こちらのページが参考になると思いますので、リンク貼っときます。

Pythonの可変長引数（*args, **kwargs）の使い方

2019-01-18

機械学習のExampleから覚えるPython(関数呼び出し)

Python

※基本的には Python3.x系のつもりで記載してます

Example

https://www.tensorflow.org/tutorials/ に記載されている

import tensorflow as tf
mnist = tf.keras.datasets.mnist

(x_train, y_train),(x_test, y_test) = mnist.load_data()
x_train, x_test = x_train / 255.0, x_test / 255.0

model = tf.keras.models.Sequential([
  tf.keras.layers.Flatten(),
  tf.keras.layers.Dense(512, activation=tf.nn.relu),
  tf.keras.layers.Dropout(0.2),
  tf.keras.layers.Dense(10, activation=tf.nn.softmax)
])
model.compile(optimizer='adam',
              loss='sparse_categorical_crossentropy',
              metrics=['accuracy'])

model.fit(x_train, y_train, epochs=5)
model.evaluate(x_test, y_test)

※本記事記載の時点のコードです。

関数の呼び出し

mnist = tf.keras.datasets.mnist

(x_train, y_train),(x_test, y_test) = mnist.load_data()

tf.keras.datasets.mnist のload_data関数を呼んでいます。
その返り値を x_train,y_train, x_test,y_testに代入しています。

load_data関数はこちらで定義されています。

@keras_export('keras.datasets.mnist.load_data')
def load_data(path='mnist.npz'):

「@」(デコレータ)は今後書こうと思います。
呼び出しの時に引数pathは default : mnist.npz のままで良いということで省略してますね。

returnとしても以下で定義されているためそのまま格納ですね！

    return (x_train, y_train), (x_test, y_test)

返り値の受け取りについては後々...

2019-01-17

機械学習のExampleから覚えるPython(import)

Python

※基本的には Python3.x系のつもりで記載してます

Example

https://www.tensorflow.org/tutorials/ に記載されている

import tensorflow as tf
mnist = tf.keras.datasets.mnist

(x_train, y_train),(x_test, y_test) = mnist.load_data()
x_train, x_test = x_train / 255.0, x_test / 255.0

model = tf.keras.models.Sequential([
  tf.keras.layers.Flatten(),
  tf.keras.layers.Dense(512, activation=tf.nn.relu),
  tf.keras.layers.Dropout(0.2),
  tf.keras.layers.Dense(10, activation=tf.nn.softmax)
])
model.compile(optimizer='adam',
              loss='sparse_categorical_crossentropy',
              metrics=['accuracy'])

model.fit(x_train, y_train, epochs=5)
model.evaluate(x_test, y_test)

※本記事記載の時点のコードです。

import

Python言語リファレンス 7.11 import文

本コードに適用するパッケージを記述します。
パッケージとは __init__.py があるディレクトリ構想のものを示します。
Python 3.3以降では __init__.py がなくても良いみたいです。

import module as identifier

import tensorflow as tf

tensorflow パッケージを読みこみ、tfと定義する。

もし、

import tensorflow

だけであれば、その後のコードは

mnist = tensorflow.keras.datasets.mnist

と書かないとエラーになります。

from relative_module import identifier

https://www.tensorflow.org/tutorials/keras/basic_classification より

# TensorFlow and tf.keras
import tensorflow as tf
from tensorflow import keras

from を使った記述があります。これは、tensorflow パッケージにある keras モジュールを呼び出してます。

その後のコードでは、kerasから記述することができます。

fashion_mnist = keras.datasets.fashion_mnist

最初の import - as で書くと

fashion_mnist = tf.keras.datasets.fashion_mnist

import時の検索範囲

環境変数「PYTHONPATH」に列挙したディレクトリ
sys.pathに含むディレクトリ
実行ディレクトリ

その他

「,」区切り

from tensorflow.keras.callbacks import EarlyStopping, ReduceLROnPlateau

とか書くことができます。 import xxxでも書けますが、Pythonのスタイルガイドでは非推奨らしいです。

PEP 8 imports -- Style Guide for Python Code | Python.org

「*」

from tensorflow import *

ですべてのモジュールをインポートすることができます。
ただ、個人的には自分で書いたライブラリ以外は必要分しかimport しないようにしてます。

追加(相対インポート)

コメントいただいたので、該当するリンクページ載せときます。

Pythonの相対インポートで上位ディレクトリ・サブディレクトリを指定