matchzoo.engine.base_callback

Base callback.

Module Contents

Classes

BaseCallback

DataGenerator callback base class.
class matchzoo.engine.base_callback.BaseCallback

Bases: abc.ABC

DataGenerator callback base class.

To build your own callbacks, inherit mz.data_generator.callbacks.Callback and overrides corresponding methods.

A batch is processed in the following way:

  • slice data pack based on batch index

  • handle on_batch_data_pack callbacks

  • unpack data pack into x, y

  • handle on_batch_x_y callbacks

  • return x, y

on_batch_data_pack(self, data_pack: mz.DataPack)

on_batch_data_pack.

Parameters

data_pack – a sliced DataPack before unpacking.

abstract on_batch_unpacked(self, x: dict, y: np.ndarray)

on_batch_unpacked.

Parameters

  • x – unpacked x.

  • y – unpacked y.