MinDiffModelなしでMinDiffを統合する

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

序章

MinDiffをモデルの実装に直接統合することが可能です。使用しての利便性はありません。そうしながらMinDiffModel 、このオプションでは、あなたのモデルがのサブクラスであるときに特に有用であり得る制御の最高レベル提供していますtf.keras.Model 。

このガイドは、あなたが追加することによって、カスタムモデルの実装に直接MinDiffを統合する方法を示しtrain_step方法。

設定

pip install -q --upgrade tensorflow-model-remediation

import tensorflow as tf
tf.get_logger().setLevel('ERROR')  # Avoid TF warnings.
from tensorflow_model_remediation import min_diff
from tensorflow_model_remediation.tools.tutorials_utils import uci as tutorials_utils

まず、データをダウンロードします。記載のように簡潔のために、入力準備ロジックは、ヘルパー機能に出て因数分解された入力の準備ガイド。このプロセスの詳細については、完全なガイドを読むことができます。

# Original Dataset for training, sampled at 0.3 for reduced runtimes.
train_df = tutorials_utils.get_uci_data(split='train', sample=0.3)
train_ds = tutorials_utils.df_to_dataset(train_df, batch_size=128)

# Dataset needed to train with MinDiff.
train_with_min_diff_ds = (
    tutorials_utils.get_uci_with_min_diff_dataset(split='train', sample=0.3))

オリジナルのカスタムモデルのカスタマイズ

tf.keras.Model簡単にサブクラスでカスタマイズできるように設計されています。これは、通常の呼び出しに何が起こるかを変更することにfit説明したように、ここで。

このガイドでは、カスタム実装使用していますtrain_step密接デフォルト似tf.keras.Model.train_step 。通常、そうすることによるメリットはありませんが、ここでは、MinDiffを統合する方法を示すのに役立ちます。

class CustomModel(tf.keras.Model):

  def train_step(self, data):
    # Unpack the data.
    x, y, sample_weight = tf.keras.utils.unpack_x_y_sample_weight(data)

    with tf.GradientTape() as tape:
      y_pred = self(x, training=True)  # Forward pass.
      loss = self.compiled_loss(
          y, y_pred, sample_weight, regularization_losses=self.losses)
      # Compute the loss value.
      loss = self.compiled_loss(
          y, y_pred, sample_weight, regularization_losses=self.losses)

    # Compute gradients and update weights.
    self.optimizer.minimize(loss, self.trainable_variables, tape=tape)
    # Update and return metrics.
    self.compiled_metrics.update_state(y, y_pred, sample_weight)
    return {m.name: m.result() for m in self.metrics}

あなたは典型的なと同じようにモデルをトレーニングModel機能APIを使用して。

model = tutorials_utils.get_uci_model(model_class=CustomModel)  # Use CustomModel.

model.compile(optimizer='adam', loss='binary_crossentropy')

_ = model.fit(train_ds, epochs=1)

77/77 [==============================] - 3s 22ms/step - loss: 0.7273

MinDiffをモデルに直接統合する

MinDiffを追加するtrain_step

MinDiffを統合するには、にいくつかの行を追加する必要がありますCustomModelとしてここに名前が変更されCustomModelWithMinDiff 。

明確にするために、このガイドでは、と呼ばれるブールフラグ使用apply_min_diff 。それがに設定されている場合MinDiffに関連するコードのすべてにのみ実行されますTrue 。設定した場合False 、モデルは正確に同じ挙動するCustomModel 。

min_diff_loss_fn = min_diff.losses.MMDLoss()  # Hard coded for convenience.
min_diff_weight = 2  # Arbitrary number for example, hard coded for convenience.
apply_min_diff = True  # Flag to help show where the additional lines are.

class CustomModelWithMinDiff(tf.keras.Model):

  def train_step(self, data):
    # Unpack the data.
    x, y, sample_weight = tf.keras.utils.unpack_x_y_sample_weight(data)

    # Unpack the MinDiff data.
    if apply_min_diff:
      min_diff_data = min_diff.keras.utils.unpack_min_diff_data(x)
      min_diff_x, membership, min_diff_sample_weight = (
          tf.keras.utils.unpack_x_y_sample_weight(min_diff_data))
      x = min_diff.keras.utils.unpack_original_inputs(x)

    with tf.GradientTape() as tape:
      y_pred = self(x, training=True)  # Forward pass.
      loss = self.compiled_loss(
          y, y_pred, sample_weight, regularization_losses=self.losses)
      # Compute the loss value.
      loss = self.compiled_loss(
          y, y_pred, sample_weight, regularization_losses=self.losses)

      # Calculate and add the min_diff_loss. This must be done within the scope
      # of tf.GradientTape().
      if apply_min_diff:
        min_diff_predictions = self(min_diff_x, training=True)
        min_diff_loss = min_diff_weight * min_diff_loss_fn(
            min_diff_predictions, membership, min_diff_sample_weight)
        loss += min_diff_loss

    # Compute gradients and update weights.
    self.optimizer.minimize(loss, self.trainable_variables, tape=tape)
    # Update and return metrics.
    self.compiled_metrics.update_state(y, y_pred, sample_weight)
    return {m.name: m.result() for m in self.metrics}

このモデルを使用したトレーニングは、使用したデータセットを除いて、前のモデルとまったく同じように見えます。

model = tutorials_utils.get_uci_model(model_class=CustomModelWithMinDiff)

model.compile(optimizer='adam', loss='binary_crossentropy')

_ = model.fit(train_with_min_diff_ds, epochs=1)

77/77 [==============================] - 4s 30ms/step - loss: 0.7799

入力の形状を変更する（オプション）

このアプローチが完全な制御を提供することを考えると、この機会を利用して、入力をわずかにクリーンな形式に再形成することができます。使用している場合MinDiffModel 、 min_diff_data各バッチの最初のコンポーネントにパックする必要があります。これは、の場合であるtrain_with_min_diff_dsデータセット。

for x, y in train_with_min_diff_ds.take(1):
  print('Type of x:', type(x))  # MinDiffPackedInputs
  print('Type of y:', type(y))  # Tensor (original labels)

Type of x: <class 'tensorflow_model_remediation.min_diff.keras.utils.input_utils.MinDiffPackedInputs'>
Type of y: <class 'tensorflow.python.framework.ops.EagerTensor'>

この要件が解除されると、元のデータとMinDiffデータが明確に分離された、もう少し直感的な構造でデータを再編成できます。

def _reformat_input(inputs, original_labels):
  min_diff_data = min_diff.keras.utils.unpack_min_diff_data(inputs)
  original_inputs = min_diff.keras.utils.unpack_original_inputs(inputs)
  original_data = (original_inputs, original_labels)

  return {
      'min_diff_data': min_diff_data,
      'original_data': original_data}

customized_train_with_min_diff_ds = train_with_min_diff_ds.map(_reformat_input)

この手順は完全にオプションですが、データをより適切に整理するのに役立ちます。その場合、あなたはどのように実装の唯一の違いCustomModelWithMinDiffあなたがどのように解凍されますdata先頭に。

class CustomModelWithMinDiff(tf.keras.Model):

  def train_step(self, data):
    # Unpack the MinDiff data from the custom structure.
    if apply_min_diff:
      min_diff_data = data['min_diff_data']
      min_diff_x, membership, min_diff_sample_weight = (
          tf.keras.utils.unpack_x_y_sample_weight(min_diff_data))
      data = data['original_data']

    ... # possible preprocessing or validation on data before unpacking.

    x, y, sample_weight = tf.keras.utils.unpack_x_y_sample_weight(data)

    ...

この最後のステップで、入力フォーマットと、MinDiffを適用するためにモデル内でどのように使用されるかを完全に制御できます。

追加リソース