Посмотреть на TensorFlow.org | Запустить в Google Colab | Посмотреть исходный код на 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.
Дополнительные ресурсы
- Для того углубленного обсуждения по оценке справедливости см руководство Справедливость Indicators
- Для получения общей информации о реабилитации и MinDiff см обзор исправления .
- Для получения дополнительной информации о требованиях окружающих MinDiff см это руководство .
- Чтобы увидеть учебник конца в конец по использованию MinDiff в Keras см этого учебника .