今日のローカルTensorFlowEverywhereイベントの出欠確認!
このページは Cloud Translation API によって翻訳されました。
Switch to English

モジュール、レイヤー、モデルの概要

TensorFlow.orgで表示 GoogleColabで実行 GitHubでソースを表示ノートブックをダウンロード

TensorFlowで機械学習を行うには、モデルを定義、保存、復元する必要があります。

モデルは、抽象的には次のとおりです。

  • テンソルで何かを計算する関数(フォワードパス
  • トレーニングに応じて更新できるいくつかの変数

このガイドでは、Kerasの表面の下に移動して、TensorFlowモデルがどのように定義されているかを確認します。これは、TensorFlowが変数とモデルを収集する方法、およびそれらがどのように保存および復元されるかを示しています。

セットアップ

import tensorflow as tf
from datetime import datetime

%load_ext tensorboard

TensorFlowでのモデルとレイヤーの定義

ほとんどのモデルはレイヤーで構成されています。レイヤーは、再利用可能でトレーニング可能な変数を持つ既知の数学的構造を持つ関数です。 TensorFlowでは、KerasやSonnetなど、レイヤーとモデルのほとんどの高レベルの実装は、同じ基本クラスtf.Module上に構築されています。

スカラーテンソルで動作する非常に単純なtf.Module例をtf.Module示します。

class SimpleModule(tf.Module):
  def __init__(self, name=None):
    super().__init__(name=name)
    self.a_variable = tf.Variable(5.0, name="train_me")
    self.non_trainable_variable = tf.Variable(5.0, trainable=False, name="do_not_train_me")
  def __call__(self, x):
    return self.a_variable * x + self.non_trainable_variable

simple_module = SimpleModule(name="simple")

simple_module(tf.constant(5.0))
<tf.Tensor: shape=(), dtype=float32, numpy=30.0>

モジュールと、ひいてはレイヤーは、「オブジェクト」の深層学習用語です。内部状態と、その状態を使用するメソッドがあります。

Pythonの呼び出し可能ファイルのように動作することを除いて、 __ __call__について特別なことは何もありません。必要な関数を使用してモデルを呼び出すことができます。

レイヤーのフリーズや微調整中の変数など、任意の理由で変数のトレーニング可能性をオンまたはオフに設定できます。

tf.Moduleサブクラスtf.Moduleことにより、このオブジェクトのプロパティに割り当てられたtf.Variableまたはtf.Moduleインスタンスが自動的に収集されます。これにより、変数を保存およびロードしたり、 tf.Moduleのコレクションを作成したりできます。

# All trainable variables
print("trainable variables:", simple_module.trainable_variables)
# Every variable
print("all variables:", simple_module.variables)
trainable variables: (<tf.Variable 'train_me:0' shape=() dtype=float32, numpy=5.0>,)
all variables: (<tf.Variable 'train_me:0' shape=() dtype=float32, numpy=5.0>, <tf.Variable 'do_not_train_me:0' shape=() dtype=float32, numpy=5.0>)

これは、モジュールで作成された2層線形層モデルの例です。

最初に高密度(線形)レイヤー:

class Dense(tf.Module):
  def __init__(self, in_features, out_features, name=None):
    super().__init__(name=name)
    self.w = tf.Variable(
      tf.random.normal([in_features, out_features]), name='w')
    self.b = tf.Variable(tf.zeros([out_features]), name='b')
  def __call__(self, x):
    y = tf.matmul(x, self.w) + self.b
    return tf.nn.relu(y)

次に、2つのレイヤーインスタンスを作成して適用する完全なモデル:

class SequentialModule(tf.Module):
  def __init__(self, name=None):
    super().__init__(name=name)

    self.dense_1 = Dense(in_features=3, out_features=3)
    self.dense_2 = Dense(in_features=3, out_features=2)

  def __call__(self, x):
    x = self.dense_1(x)
    return self.dense_2(x)

# You have made a model!
my_model = SequentialModule(name="the_model")

# Call it, with random results
print("Model results:", my_model(tf.constant([[2.0, 2.0, 2.0]])))
​​
Model results: tf.Tensor([[1.3485138 0.       ]], shape=(1, 2), dtype=float32)

tf.Moduleインスタンスは、割り当てられたtf.Variableまたはtf.Moduleインスタンスを再帰的に自動的に収集します。これにより、単一のモデルインスタンスでtf.Moduleのコレクションを管理し、モデル全体を保存およびロードできます。

print("Submodules:", my_model.submodules)
Submodules: (<__main__.Dense object at 0x7f7ee03162b0>, <__main__.Dense object at 0x7f7f9de66828>)

for var in my_model.variables:
  print(var, "\n")
<tf.Variable 'b:0' shape=(3,) dtype=float32, numpy=array([0., 0., 0.], dtype=float32)> 

<tf.Variable 'w:0' shape=(3, 3) dtype=float32, numpy=
array([[ 0.42973468,  0.15992774, -1.6392574 ],
       [-0.7671939 , -0.20895211,  0.6442926 ],
       [ 1.2163191 , -0.3674516 , -1.705927  ]], dtype=float32)> 

<tf.Variable 'b:0' shape=(2,) dtype=float32, numpy=array([0., 0.], dtype=float32)> 

<tf.Variable 'w:0' shape=(3, 2) dtype=float32, numpy=
array([[ 0.76719505, -0.47276816],
       [-0.1961423 , -1.5055978 ],
       [-1.4694569 ,  0.39977267]], dtype=float32)> 


変数の作成を待っています

ここで、レイヤーへの入力サイズと出力サイズの両方を定義する必要があることに気付いたかもしれません。これは、 w変数が既知の形状を持ち、割り当てることができるようにするためです。

モジュールが特定の入力形状で最初に呼び出されるまで変数の作成を延期することにより、入力サイズを事前に指定する必要がありません。

class FlexibleDenseModule(tf.Module):
  # Note: No need for `in_features`
  def __init__(self, out_features, name=None):
    super().__init__(name=name)
    self.is_built = False
    self.out_features = out_features

  def __call__(self, x):
    # Create variables on first call.
    if not self.is_built:
      self.w = tf.Variable(
        tf.random.normal([x.shape[-1], self.out_features]), name='w')
      self.b = tf.Variable(tf.zeros([self.out_features]), name='b')
      self.is_built = True

    y = tf.matmul(x, self.w) + self.b
    return tf.nn.relu(y)
# Used in a module
class MySequentialModule(tf.Module):
  def __init__(self, name=None):
    super().__init__(name=name)

    self.dense_1 = FlexibleDenseModule(out_features=3)
    self.dense_2 = FlexibleDenseModule(out_features=2)

  def __call__(self, x):
    x = self.dense_1(x)
    return self.dense_2(x)

my_model = MySequentialModule(name="the_model")
print("Model results:", my_model(tf.constant([[2.0, 2.0, 2.0]])))
Model results: tf.Tensor([[0.88676476 0.17552769]], shape=(1, 2), dtype=float32)

この柔軟性が、TensorFlowレイヤーが、入力サイズと出力サイズの両方ではなく、 tf.keras.layers.Denseなどの出力の形状を指定するだけでよいことが多い理由です。

ウェイトの節約

tf.ModuleチェックポイントSavedModelの両方として保存できます。

チェックポイントは単なる重み(つまり、モジュールとそのサブモジュール内の変数のセットの値)です。

chkp_path = "my_checkpoint"
checkpoint = tf.train.Checkpoint(model=my_model)
checkpoint.write(chkp_path)
'my_checkpoint'

チェックポイントは、データ自体とメタデータのインデックスファイルの2種類のファイルで構成されます。インデックスファイルは、実際に保存されているものとチェックポイントの番号を追跡し、チェックポイントデータには変数値とその属性ルックアップパスが含まれています。

ls my_checkpoint*
my_checkpoint.data-00000-of-00001  my_checkpoint.index

チェックポイントの内部を調べて、変数のコレクション全体が保存されていることを確認し、変数を含むPythonオブジェクトで並べ替えることができます。

tf.train.list_variables(chkp_path)
[('_CHECKPOINTABLE_OBJECT_GRAPH', []),
 ('model/dense_1/b/.ATTRIBUTES/VARIABLE_VALUE', [3]),
 ('model/dense_1/w/.ATTRIBUTES/VARIABLE_VALUE', [3, 3]),
 ('model/dense_2/b/.ATTRIBUTES/VARIABLE_VALUE', [2]),
 ('model/dense_2/w/.ATTRIBUTES/VARIABLE_VALUE', [3, 2])]

分散(マルチマシン)トレーニング中に、それらはシャーディングされる可能性があります。そのため、番号が付けられます(たとえば、「00000-of-00001」)。ただし、この場合、シャードは1つしかありません。

モデルを再度ロードすると、Pythonオブジェクトの値が上書きされます。

new_model = MySequentialModule()
new_checkpoint = tf.train.Checkpoint(model=new_model)
new_checkpoint.restore("my_checkpoint")

# Should be the same result as above
new_model(tf.constant([[2.0, 2.0, 2.0]]))
<tf.Tensor: shape=(1, 2), dtype=float32, numpy=array([[0.88676476, 0.17552769]], dtype=float32)>

保存機能

TensorFlow Hubからトレーニング済みモデルをダウンロードした場合でも、 TensorFlowServingTensorFlowLiteで示されているように、 TensorFlowは元のPythonオブジェクトなしでモデルを実行できます。

TensorFlowは、Pythonで説明されている計算を実行する方法を知っている必要がありますが、元のコードはありません。これを行うには、グラフと関数の概要ガイドで説明されているグラフを作成できます。

このグラフは、機能を実装する操作、またはOPSが含まれています。

@tf.functionデコレータを追加して、このコードをグラフとして実行する必要があることを示すことにより、上のモデルでグラフを定義できます。

class MySequentialModule(tf.Module):
  def __init__(self, name=None):
    super().__init__(name=name)

    self.dense_1 = Dense(in_features=3, out_features=3)
    self.dense_2 = Dense(in_features=3, out_features=2)

  @tf.function
  def __call__(self, x):
    x = self.dense_1(x)
    return self.dense_2(x)

# You have made a model with a graph!
my_model = MySequentialModule(name="the_model")

作成したモジュールは、以前とまったく同じように機能します。関数に渡される一意の署名ごとに、個別のグラフが作成されます。詳細については、グラフと関数の概要ガイドを確認してください。

print(my_model([[2.0, 2.0, 2.0]]))
print(my_model([[[2.0, 2.0, 2.0], [2.0, 2.0, 2.0]]]))
tf.Tensor([[2.1462612 0.       ]], shape=(1, 2), dtype=float32)
tf.Tensor(
[[[2.1462612 0.       ]
  [2.1462612 0.       ]]], shape=(1, 2, 2), dtype=float32)

TensorBoardサマリー内でグラフをトレースすることにより、グラフを視覚化できます。

# Set up logging.
stamp = datetime.now().strftime("%Y%m%d-%H%M%S")
logdir = "logs/func/%s" % stamp
writer = tf.summary.create_file_writer(logdir)

# Create a new model to get a fresh trace
# Otherwise the summary will not see the graph.
new_model = MySequentialModule()

# Bracket the function call with
# tf.summary.trace_on() and tf.summary.trace_export().
tf.summary.trace_on(graph=True)
tf.profiler.experimental.start(logdir)
# Call only one tf.function when tracing.
z = print(new_model(tf.constant([[2.0, 2.0, 2.0]])))
with writer.as_default():
  tf.summary.trace_export(
      name="my_func_trace",
      step=0,
      profiler_outdir=logdir)
tf.Tensor([[0.         0.21672514]], shape=(1, 2), dtype=float32)

TensorBoardを起動して、結果のトレースを表示します。

%tensorboard --logdir logs/func

TensorBoardのグラフのスクリーンショット

SavedModel作成

完全にトレーニングされたモデルを共有するための推奨される方法は、 SavedModelを使用することSavedModelSavedModelは、関数のコレクションと重みのコレクションの両方が含まれています。

トレーニングしたばかりのモデルを次のように保存できます。

tf.saved_model.save(my_model, "the_saved_model")
INFO:tensorflow:Assets written to: the_saved_model/assets

# Inspect the SavedModel in the directory
ls -l the_saved_model
total 24
drwxr-sr-x 2 kbuilder kokoro  4096 Feb 23 02:23 assets
-rw-rw-r-- 1 kbuilder kokoro 14140 Feb 23 02:23 saved_model.pb
drwxr-sr-x 2 kbuilder kokoro  4096 Feb 23 02:23 variables

# The variables/ directory contains a checkpoint of the variables
ls -l the_saved_model/variables
total 8
-rw-rw-r-- 1 kbuilder kokoro 408 Feb 23 02:23 variables.data-00000-of-00001
-rw-rw-r-- 1 kbuilder kokoro 356 Feb 23 02:23 variables.index

saved_model.pbファイルは、機能的なtf.Graphを記述するプロトコルバッファtf.Graph

モデルとレイヤーは、それを作成したクラスのインスタンスを実際に作成しなくても、この表現からロードできます。これは、大規模なサービスやエッジデバイスでのサービスなど、Pythonインタープリターがない(または必要ない)状況、または元のPythonコードが利用できないか実用的でない状況で必要になります。

モデルを新しいオブジェクトとしてロードできます。

new_model = tf.saved_model.load("the_saved_model")

new_model 、保存されたモデルをロードから作成され、クラスの知識の任意ことなく内部TensorFlowユーザオブジェクトです。タイプはSequentialModuleはありません。

isinstance(new_model, SequentialModule)
False

この新しいモデルは、すでに定義されている入力署名で機能します。このように復元されたモデルに署名を追加することはできません。

print(my_model([[2.0, 2.0, 2.0]]))
print(my_model([[[2.0, 2.0, 2.0], [2.0, 2.0, 2.0]]]))
tf.Tensor([[2.1462612 0.       ]], shape=(1, 2), dtype=float32)
tf.Tensor(
[[[2.1462612 0.       ]
  [2.1462612 0.       ]]], shape=(1, 2, 2), dtype=float32)

したがって、 SavedModelを使用すると、 SavedModelを使用してTensorFlowの重みとグラフをtf.Module 、それらを再度読み込むことができます。

Kerasモデルとレイヤー

この時点まで、Kerasについての言及はないことに注意してください。 tf.Module上に独自の高レベルAPIを構築でき、人々はそれを持っています。

このセクションでは、 tf.Moduleをどのように使用するかを調べます。 Kerasモデルの完全なユーザーガイドは、 Kerasガイドにあります。

Kerasレイヤー

tf.keras.layers.Layerは、すべてのtf.keras.layers.Layerの基本クラスであり、 tf.Moduleから継承しtf.Module

親を交換し、 __call__call変更するだけで、モジュールをKerasレイヤーに変換できcall

class MyDense(tf.keras.layers.Layer):
  # Adding **kwargs to support base Keras layer arguments
  def __init__(self, in_features, out_features, **kwargs):
    super().__init__(**kwargs)

    # This will soon move to the build step; see below
    self.w = tf.Variable(
      tf.random.normal([in_features, out_features]), name='w')
    self.b = tf.Variable(tf.zeros([out_features]), name='b')
  def call(self, x):
    y = tf.matmul(x, self.w) + self.b
    return tf.nn.relu(y)

simple_layer = MyDense(name="simple", in_features=3, out_features=3)

Kerasレイヤーには独自の__call__があり、次のセクションで説明する簿記を実行してから、 call()呼び出しcall() 。機能に変更はありません。

simple_layer([[2.0, 2.0, 2.0]])
<tf.Tensor: shape=(1, 3), dtype=float32, numpy=array([[2.6720052 , 0.04484487, 2.9167585 ]], dtype=float32)>

buildステップ

前述のように、多くの場合、入力形状が確定するまで変数の作成を待つと便利です。

Kerasレイヤーには、レイヤーの定義方法をより柔軟に設定できる追加のライフサイクルステップが付属しています。これはbuild関数で定義されます。

buildは1回だけ呼び出され、入力の形状で呼び出されます。通常、変数(重み)を作成するために使用されます。

上記のMyDenseレイヤーを書き換えて、入力のサイズに柔軟に対応できます。

class FlexibleDense(tf.keras.layers.Layer):
  # Note the added `**kwargs`, as Keras supports many arguments
  def __init__(self, out_features, **kwargs):
    super().__init__(**kwargs)
    self.out_features = out_features

  def build(self, input_shape):  # Create the state of the layer (weights)
    self.w = tf.Variable(
      tf.random.normal([input_shape[-1], self.out_features]), name='w')
    self.b = tf.Variable(tf.zeros([self.out_features]), name='b')

  def call(self, inputs):  # Defines the computation from inputs to outputs
    return tf.matmul(inputs, self.w) + self.b

# Create the instance of the layer
flexible_dense = FlexibleDense(out_features=3)

この時点では、モデルは構築されていないため、変数はありません。

flexible_dense.variables
[]

関数を呼び出すと、適切なサイズの変数が割り当てられます。

# Call it, with predictably random results
print("Model results:", flexible_dense(tf.constant([[2.0, 2.0, 2.0], [3.0, 3.0, 3.0]])))
Model results: tf.Tensor(
[[-0.94684243  0.23555051 -1.2174213 ]
 [-1.420264    0.35332587 -1.8261317 ]], shape=(2, 3), dtype=float32)

flexible_dense.variables
[<tf.Variable 'flexible_dense/w:0' shape=(3, 3) dtype=float32, numpy=
 array([[-0.78728116, -1.0460894 , -0.373664  ],
        [-0.04601809,  1.0472184 , -0.78263795],
        [ 0.359878  ,  0.11664622,  0.5475913 ]], dtype=float32)>,
 <tf.Variable 'flexible_dense/b:0' shape=(3,) dtype=float32, numpy=array([0., 0., 0.], dtype=float32)>]

buildは1回しか呼び出されないため、入力シェイプがレイヤーの変数と互換性がない場合、入力は拒否されます。

try:
  print("Model results:", flexible_dense(tf.constant([[2.0, 2.0, 2.0, 2.0]])))
except tf.errors.InvalidArgumentError as e:
  print("Failed:", e)
Failed: Matrix size-incompatible: In[0]: [1,4], In[1]: [3,3] [Op:MatMul]

Kerasレイヤーには、次のような多くの追加機能があります。

  • オプションの損失
  • メトリックのサポート
  • トレーニングと推論の使用を区別するためのオプションのtraining引数の組み込みサポート
  • get_configfrom_configあなたは正確にPythonでモデルクローニングを許可するように設定を保存できるようにする方法

カスタムレイヤーとモデルの完全ガイドでそれらについてお読みください。

Kerasモデル

モデルをネストされたKerasレイヤーとして定義できます。

ただし、 tf.keras.Modelと呼ばれるフル機能のモデルクラスも提供します。 tf.keras.layers.Layerから継承するため、 tf.keras.layers.Layerモデルは、 tf.keras.layers.Layerレイヤーと同じ方法で使用、ネスト、および保存できます。 Kerasモデルには、トレーニング、評価、ロード、保存、さらには複数のマシンでのトレーニングを容易にする追加機能が付属しています。

ほぼ同じコードで上からSequentialModuleを定義し、再び__call__call()変換して、親を変更できます。

class MySequentialModel(tf.keras.Model):
  def __init__(self, name=None, **kwargs):
    super().__init__(**kwargs)

    self.dense_1 = FlexibleDense(out_features=3)
    self.dense_2 = FlexibleDense(out_features=2)
  def call(self, x):
    x = self.dense_1(x)
    return self.dense_2(x)

# You have made a Keras model!
my_sequential_model = MySequentialModel(name="the_model")

# Call it on a tensor, with random results
print("Model results:", my_sequential_model(tf.constant([[2.0, 2.0, 2.0]])))
Model results: tf.Tensor([[-0.66161615  2.676058  ]], shape=(1, 2), dtype=float32)

追跡変数やサブモジュールなど、すべて同じ機能を利用できます。

my_sequential_model.variables
[<tf.Variable 'my_sequential_model/flexible_dense_1/w:0' shape=(3, 3) dtype=float32, numpy=
 array([[-1.0083866 ,  0.3327814 ,  1.3844662 ],
        [ 1.5690744 , -0.02959401, -0.93022144],
        [-0.14460103,  0.28575286, -0.04719478]], dtype=float32)>,
 <tf.Variable 'my_sequential_model/flexible_dense_1/b:0' shape=(3,) dtype=float32, numpy=array([0., 0., 0.], dtype=float32)>,
 <tf.Variable 'my_sequential_model/flexible_dense_2/w:0' shape=(3, 2) dtype=float32, numpy=
 array([[ 0.68169326,  0.66519386],
        [-0.45149076,  1.8603013 ],
        [-0.8562843 , -0.0844016 ]], dtype=float32)>,
 <tf.Variable 'my_sequential_model/flexible_dense_2/b:0' shape=(2,) dtype=float32, numpy=array([0., 0.], dtype=float32)>]
my_sequential_model.submodules
(<__main__.FlexibleDense at 0x7f7f1fe40080>,
 <__main__.FlexibleDense at 0x7f7f5beb4dd8>)

tf.keras.Modelオーバーライドは、TensorFlowモデルを構築するための非常にPython的なアプローチです。他のフレームワークからモデルを移行する場合、これは非常に簡単です。

既存のレイヤーと入力を単純に組み合わせたモデルを構築する場合は、モデルの再構築とアーキテクチャに関する追加機能を備えた機能APIを使用することで、時間とスペースを節約できます。

これは、機能APIを使用した同じモデルです。

inputs = tf.keras.Input(shape=[3,])

x = FlexibleDense(3)(inputs)
x = FlexibleDense(2)(x)

my_functional_model = tf.keras.Model(inputs=inputs, outputs=x)

my_functional_model.summary()
Model: "model"
_________________________________________________________________
Layer (type)                 Output Shape              Param #   
=================================================================
input_1 (InputLayer)         [(None, 3)]               0         
_________________________________________________________________
flexible_dense_3 (FlexibleDe (None, 3)                 12        
_________________________________________________________________
flexible_dense_4 (FlexibleDe (None, 2)                 8         
=================================================================
Total params: 20
Trainable params: 20
Non-trainable params: 0
_________________________________________________________________

my_functional_model(tf.constant([[2.0, 2.0, 2.0]]))
<tf.Tensor: shape=(1, 2), dtype=float32, numpy=array([[ 1.6514727, -1.1012284]], dtype=float32)>

ここでの主な違いは、入力形状が機能構築プロセスの一部として事前に指定されることです。この場合のinput_shape引数は、完全に指定する必要はありません。一部のディメンションは「 Noneままにしておくことができます。

Kerasモデルの保存

Kerasモデルはチェックポイントを設定でき、 tf.Moduleと同じようにtf.Moduleます。

Kerasモデルはモジュールであるため、 tf.saved_models.save()を使用して保存することもできます。ただし、Kerasモデルには便利なメソッドとその他の機能があります。

my_sequential_model.save("exname_of_file")
INFO:tensorflow:Assets written to: exname_of_file/assets

同様に簡単に、次の場所に再度読み込むことができます。

reconstructed_model = tf.keras.models.load_model("exname_of_file")
WARNING:tensorflow:No training configuration found in save file, so the model was *not* compiled. Compile it manually.

SavedModelsは、メトリック、損失、およびオプティマイザーの状態も保存します。

この再構築されたモデルを使用でき、同じデータで呼び出されたときに同じ結果が生成されます。

reconstructed_model(tf.constant([[2.0, 2.0, 2.0]]))
<tf.Tensor: shape=(1, 2), dtype=float32, numpy=array([[-0.66161615,  2.676058  ]], dtype=float32)>

機能サポートのためのカスタムレイヤーの構成方法の提供など、Kerasモデルの保存とシリアル化についてもっと知っておくべきことがあります。保存とシリアル化ガイドを確認してください

次は何ですか

Kerasの詳細を知りたい場合は、ここで既存のKerasガイドに従うことができます。

tf.module上に構築された高レベルAPIのもう1つの例は、DeepMindのSonnetです。これは、彼らのサイトでカバーされています