Custom callbacks in TensorFlow

Introduction

Custom callbacks let you add your own actions during model training, like stopping early or saving progress.

You want to stop training when the model stops improving.

You want to save the model after each training round.

You want to print extra information during training.

You want to change learning rate based on training progress.

You want to log custom metrics or events.

Syntax

TensorFlow

class MyCallback(tf.keras.callbacks.Callback):
    def on_epoch_end(self, epoch, logs=None):
        # Your code here
        pass

model.fit(x_train, y_train, epochs=5, callbacks=[MyCallback()])

Create a class that inherits from tf.keras.callbacks.Callback.

Override methods like on_epoch_end to add your code.

Examples

Prints a message after each epoch.

TensorFlow

class PrintEpochCallback(tf.keras.callbacks.Callback):
    def on_epoch_end(self, epoch, logs=None):
        print(f"Finished epoch {epoch + 1}")

Stops training early if loss is below 0.1.

TensorFlow

class StopIfLossLow(tf.keras.callbacks.Callback):
    def on_epoch_end(self, epoch, logs=None):
        if logs.get('loss') < 0.1:
            print('Loss is low, stopping training')
            self.model.stop_training = True

Sample Model

This program trains a simple model to learn y=2x. It uses a custom callback to print loss each epoch and stop training early when loss is below 0.01.

TensorFlow

import tensorflow as tf
import numpy as np

# Create simple data
x_train = np.array([[1], [2], [3], [4]], dtype=float)
y_train = np.array([[2], [4], [6], [8]], dtype=float)

# Define a simple model
model = tf.keras.Sequential([
    tf.keras.layers.Dense(1, input_shape=(1,))
])
model.compile(optimizer='sgd', loss='mean_squared_error')

# Custom callback to stop if loss < 0.01
class StopIfLossLow(tf.keras.callbacks.Callback):
    def on_epoch_end(self, epoch, logs=None):
        loss = logs.get('loss')
        print(f"Epoch {epoch + 1}, loss: {loss:.4f}")
        if loss is not None and loss < 0.01:
            print('Loss is low, stopping training')
            self.model.stop_training = True

# Train model with callback
model.fit(x_train, y_train, epochs=20, callbacks=[StopIfLossLow()])

Important Notes

Callbacks can access training info like loss and accuracy via the logs parameter.

You can override many methods like on_train_begin, on_batch_end, on_epoch_end.

Use self.model.stop_training = True to stop training early.

Summary

Custom callbacks let you run your own code during training.

Create a class inheriting from tf.keras.callbacks.Callback and override methods.

Use callbacks to monitor, stop, or save your model during training.

Practice

1. What is the main purpose of creating a custom callback in TensorFlow?

easy

A. To run your own code at specific points during model training

B. To change the model architecture automatically

C. To increase the dataset size during training

D. To convert the model to a different format

Solution

1. Step 1: Understand what callbacks do

   Callbacks let you add custom actions during training, like logging or stopping early.

2. Step 2: Identify the role of custom callbacks

   Custom callbacks let you run your own code at points like start/end of epochs or batches.

3. Final Answer:

   To run your own code at specific points during model training -> Option A

4. Quick Check:

   Custom callbacks = run code during training [OK]

Hint: Callbacks run code during training steps [OK]

Common Mistakes:

• Thinking callbacks change model structure
• Confusing callbacks with data augmentation
• Assuming callbacks convert model formats

2. Which method should you override in a custom callback to execute code at the end of each training epoch?

easy

A. on_train_begin

B. on_epoch_end

C. on_batch_begin

D. on_train_end

Solution

1. Step 1: Recall callback method names

   Common callback methods include on_train_begin, on_epoch_end, on_batch_begin, on_train_end.

2. Step 2: Match method to event

   on_epoch_end runs code after each epoch finishes, which is what the question asks.

3. Final Answer:

   on_epoch_end -> Option B

4. Quick Check:

   End of epoch method = on_epoch_end [OK]

Hint: End of epoch callback method is on_epoch_end [OK]

Common Mistakes:

• Using on_train_begin for epoch end
• Confusing batch and epoch methods
• Overriding on_train_end instead

3. What will be printed after training if this custom callback is used?

import tensorflow as tf
class MyCallback(tf.keras.callbacks.Callback):
    def on_epoch_end(self, epoch, logs=None):
        print(f"Epoch {epoch+1} ended with loss {logs['loss']:.2f}")

model = tf.keras.Sequential([tf.keras.layers.Dense(1)])
model.compile(optimizer='sgd', loss='mse')
model.fit([[1.0]], [[2.0]], epochs=2, callbacks=[MyCallback()])

medium

A. Error because logs is None

B. Epoch 0 ended with loss X\nEpoch 1 ended with loss Y

C. No output printed during training

D. Epoch 1 ended with loss X\nEpoch 2 ended with loss Y (X and Y are numbers)

Solution

1. Step 1: Understand on_epoch_end behavior

   The method prints epoch number +1 and loss from logs after each epoch.

2. Step 2: Check training epochs and output

   Training runs 2 epochs, so prints for epoch 1 and 2 with loss values (numbers).

3. Final Answer:

   Epoch 1 ended with loss X\nEpoch 2 ended with loss Y (X and Y are numbers) -> Option D

4. Quick Check:

   Prints after each epoch with loss [OK]

Hint: Epoch count starts at 0, print adds 1 [OK]

Common Mistakes:

• Assuming epoch numbering starts at 1 internally
• Expecting no print output
• Thinking logs is None causing error

4. Identify the error in this custom callback code that tries to stop training when loss is below 0.1:

class StopCallback(tf.keras.callbacks.Callback):
    def on_epoch_end(self, epoch, logs=None):
        if logs['loss'] < 0.1:
            self.model.stop_training = True

model.fit(x_train, y_train, epochs=10, callbacks=[StopCallback()])

medium

A. on_epoch_end method must return a value

B. stop_training should be called as a method

C. logs dictionary might be None causing KeyError

D. Callback class must inherit from tf.keras.Model

Solution

1. Step 1: Check logs usage

   logs can be None if no metrics are passed, so logs['loss'] may cause KeyError.

2. Step 2: Confirm correct way to stop training

   Setting self.model.stop_training = True is correct; no method call needed.

3. Final Answer:

   logs dictionary might be None causing KeyError -> Option C

4. Quick Check:

   Check logs is not None before accessing [OK]

Hint: Always check logs is not None before using keys [OK]

Common Mistakes:

• Calling stop_training as a method
• Expecting on_epoch_end to return a value
• Inheriting from wrong base class

5. You want to save the model weights only when validation accuracy improves during training. Which custom callback method and logic should you implement?

hard

A. Override on_epoch_end, check logs['val_accuracy'], save weights if improved

B. Override on_train_begin, save weights before training starts

C. Override on_batch_end, save weights after every batch

D. Override on_train_end, save weights after training finishes

Solution

1. Step 1: Identify when to check validation accuracy

   Validation accuracy is updated at epoch end, so on_epoch_end is the right method.

2. Step 2: Implement logic to save weights only if val_accuracy improves

   Inside on_epoch_end, compare current val_accuracy with previous best and save if better.

3. Final Answer:

   Override on_epoch_end, check logs['val_accuracy'], save weights if improved -> Option A

4. Quick Check:

   Save on epoch end if val_accuracy improves [OK]

Hint: Use on_epoch_end to monitor validation metrics [OK]

Common Mistakes:

• Saving weights too often (every batch)
• Saving only before or after all training
• Not checking if accuracy improved before saving