Wstęp
Możliwa jest integracja MinDiff bezpośrednio z implementacją Twojego modelu. Czyniąc tak, nie ma wygodę korzystania MinDiffModel
, opcja ta zapewnia najwyższy poziom kontroli, które mogą być szczególnie użyteczne, gdy model jest podklasą tf.keras.Model
.
Ten poradnik pokazuje, jak można zintegrować MinDiff bezpośrednio do realizacji niestandardowego modelu poprzez dodanie do train_step
metody.
Ustawiać
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
Najpierw pobierz dane. Dla zwięzłości, logika przygotowanie wejścia zostały uwzględnione z pomocnikiem do funkcji opisanych w przewodniku przygotowania wejścia . Możesz przeczytać pełny przewodnik, aby uzyskać szczegółowe informacje na temat tego procesu.
# 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))
Oryginalne niestandardowe dostosowania modelu
tf.keras.Model
jest zaprojektowany do być łatwo dostosowane poprzez instacji. Zwykle wiąże się ze zmianą, co dzieje się w zaproszeniu do fit
jak opisano tutaj .
Podręcznik ten wykorzystuje niestandardową implementację gdzie train_step
ściśle przypomina domyślny tf.keras.Model.train_step
. Normalnie nie byłoby z tego korzyści, ale tutaj pomoże zademonstrować, jak zintegrować 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}
Trenować model jak byś to typowy Model
używając API funkcjonalna.
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
Integracja MinDiff bezpośrednio z Twoim modelem
Dodawanie MinDiff do train_step
Aby zintegrować MinDiff, trzeba będzie dodać kilka linii do CustomModel
który przemianowano tutaj jako CustomModelWithMinDiff
.
Dla jasności, ten poradnik wykorzystuje flagę logiczną nazwie apply_min_diff
. Cały kod właściwego do MinDiff będą uruchamiane tylko wtedy, gdy jest ustawiona na True
. Jeśli jest ustawiona na False
następnie model będzie zachowywać się dokładnie tak samo jak 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}
Trening z tym modelem wygląda dokładnie tak samo, jak w poprzednim, z wyjątkiem użytego zestawu danych.
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
Zmiana kształtu danych wejściowych (opcjonalnie)
Biorąc pod uwagę, że takie podejście zapewnia pełną kontrolę, możesz skorzystać z okazji, aby przekształcić dane wejściowe w nieco czystszą formę. Podczas korzystania MinDiffModel
The min_diff_data
musi być pakowane w pierwszym składniku każdej partii. Jest to przypadek z train_with_min_diff_ds
zbiorze.
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'>
Po zniesieniu tego wymogu możesz zreorganizować dane w nieco bardziej intuicyjną strukturę z czystym rozdzieleniem oryginalnych danych i danych 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)
Ten krok jest całkowicie opcjonalny, ale może być przydatny do lepszej organizacji danych. Jeśli tak, jedyna różnica w tym, jak wdrożyć CustomModelWithMinDiff
będzie jak rozpakować data
na początku.
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)
...
W tym ostatnim kroku możesz w pełni kontrolować zarówno format wejściowy, jak i sposób jego użycia w modelu, aby zastosować MinDiff.
Dodatkowe zasoby
- Dla dogłębnej dyskusji na temat oceny rzetelności patrz wytyczne Fairness Indicators
- Aby uzyskać ogólne informacje na naprawę i MinDiff, zobacz przegląd naprawcze .
- Szczegółowe informacje na temat wymagań otaczających MinDiff zobaczyć ten podręcznik .
- Aby zobaczyć samouczek end-to-end na wykorzystaniu MinDiff w Keras, zobacz ten samouczek .