tf.keras.callbacks.CallbackList | TensorFlow v2.16.1 (original) (raw)

Container abstracting a list of callbacks.

Inherits From: Callback

tf.keras.callbacks.CallbackList(
    callbacks=None, add_history=False, add_progbar=False, model=None, **params
)

Args
callbacks	List of Callback instances.
add_history	Whether a History callback should be added, if one does not already exist in the callbacks list.
add_progbar	Whether a ProgbarLogger callback should be added, if one does not already exist in the callbacks list.
model	The Model these callbacks are used with.
**params	If provided, parameters will be passed to each Callbackvia Callback.set_params.

| Attributes | | | ---------- | | | model | |

Methods

`append`

View source

append(
    callback
)

`on_batch_begin`

View source

on_batch_begin(
    batch, logs=None
)

A backwards compatibility alias for on_train_batch_begin.

`on_batch_end`

View source

on_batch_end(
    batch, logs=None
)

A backwards compatibility alias for on_train_batch_end.

`on_epoch_begin`

View source

on_epoch_begin(
    epoch, logs=None
)

Called at the start of an epoch.

Subclasses should override for any actions to run. This function should only be called during TRAIN mode.

Args
epoch	Integer, index of epoch.
logs	Dict. Currently no data is passed to this argument for this method but that may change in the future.

`on_epoch_end`

View source

on_epoch_end(
    epoch, logs=None
)

Called at the end of an epoch.

Subclasses should override for any actions to run. This function should only be called during TRAIN mode.

Args
epoch	Integer, index of epoch.
logs	Dict, metric results for this training epoch, and for the validation epoch if validation is performed. Validation result keys are prefixed with val_. For training epoch, the values of the Model's metrics are returned. Example:{'loss': 0.2, 'accuracy': 0.7}.

`on_predict_batch_begin`

View source

on_predict_batch_begin(
    batch, logs=None
)

Called at the beginning of a batch in predict methods.

Subclasses should override for any actions to run.

Note that if the steps_per_execution argument to compile inModel is set to N, this method will only be called everyN batches.

Args
batch	Integer, index of batch within the current epoch.
logs	Dict. Currently no data is passed to this argument for this method but that may change in the future.

`on_predict_batch_end`

View source

on_predict_batch_end(
    batch, logs=None
)

Called at the end of a batch in predict methods.

Subclasses should override for any actions to run.

Note that if the steps_per_execution argument to compile inModel is set to N, this method will only be called everyN batches.

Args
batch	Integer, index of batch within the current epoch.
logs	Dict. Aggregated metric results up until this batch.

`on_predict_begin`

View source

on_predict_begin(
    logs=None
)

Called at the beginning of prediction.

Subclasses should override for any actions to run.

Args
logs	Dict. Currently no data is passed to this argument for this method but that may change in the future.

`on_predict_end`

View source

on_predict_end(
    logs=None
)

Called at the end of prediction.

Subclasses should override for any actions to run.

Args
logs	Dict. Currently no data is passed to this argument for this method but that may change in the future.

`on_test_batch_begin`

View source

on_test_batch_begin(
    batch, logs=None
)

Called at the beginning of a batch in evaluate methods.

Also called at the beginning of a validation batch in the fitmethods, if validation data is provided.

Subclasses should override for any actions to run.

Note that if the steps_per_execution argument to compile inModel is set to N, this method will only be called everyN batches.

Args
batch	Integer, index of batch within the current epoch.
logs	Dict. Currently no data is passed to this argument for this method but that may change in the future.

`on_test_batch_end`

View source

on_test_batch_end(
    batch, logs=None
)

Called at the end of a batch in evaluate methods.

Also called at the end of a validation batch in the fitmethods, if validation data is provided.

Subclasses should override for any actions to run.

Note that if the steps_per_execution argument to compile inModel is set to N, this method will only be called everyN batches.

Args
batch	Integer, index of batch within the current epoch.
logs	Dict. Aggregated metric results up until this batch.

`on_test_begin`

View source

on_test_begin(
    logs=None
)

Called at the beginning of evaluation or validation.

Subclasses should override for any actions to run.

Args
logs	Dict. Currently no data is passed to this argument for this method but that may change in the future.

`on_test_end`

View source

on_test_end(
    logs=None
)

Called at the end of evaluation or validation.

Subclasses should override for any actions to run.

Args
logs	Dict. Currently the output of the last call toon_test_batch_end() is passed to this argument for this method but that may change in the future.

`on_train_batch_begin`

View source

on_train_batch_begin(
    batch, logs=None
)

Called at the beginning of a training batch in fit methods.

Subclasses should override for any actions to run.

Note that if the steps_per_execution argument to compile inModel is set to N, this method will only be called everyN batches.

Args
batch	Integer, index of batch within the current epoch.
logs	Dict. Currently no data is passed to this argument for this method but that may change in the future.

`on_train_batch_end`

View source

on_train_batch_end(
    batch, logs=None
)

Called at the end of a training batch in fit methods.

Subclasses should override for any actions to run.

Note that if the steps_per_execution argument to compile inModel is set to N, this method will only be called everyN batches.

Args
batch	Integer, index of batch within the current epoch.
logs	Dict. Aggregated metric results up until this batch.

`on_train_begin`

View source

on_train_begin(
    logs=None
)

Called at the beginning of training.

Subclasses should override for any actions to run.

Args
logs	Dict. Currently no data is passed to this argument for this method but that may change in the future.

`on_train_end`

View source

on_train_end(
    logs=None
)

Called at the end of training.

Subclasses should override for any actions to run.

Args
logs	Dict. Currently the output of the last call toon_epoch_end() is passed to this argument for this method but that may change in the future.

`set_model`

View source

set_model(
    model
)

`set_params`

View source

set_params(
    params
)