tf.keras.callbacks.RemoteMonitor

View source on GitHub

Class `RemoteMonitor`

Callback used to stream events to a server.

Inherits From: Callback

Aliases:

Requires the requests library. Events are sent to root + '/publish/epoch/end/' by default. Calls are HTTP POST, with a data argument which is a JSON-encoded dictionary of event data. If send_as_json is set to True, the content type of the request will be application/json. Otherwise the serialized JSON will be sent within a form.

Arguments:

root: String; root url of the target server.
path: String; path relative to root to which the events will be sent.
field: String; JSON field under which the data will be stored. The field is used only if the payload is sent within a form (i.e. send_as_json is set to False).
headers: Dictionary; optional custom HTTP headers.
send_as_json: Boolean; whether the request should be sent as application/json.

`init`

__init__(
    root='http://localhost:9000',
    path='/publish/epoch/end/',
    field='data',
    headers=None,
    send_as_json=False
)

Initialize self. See help(type(self)) for accurate signature.

Methods

`tf.keras.callbacks.RemoteMonitor.on_batch_begin`

on_batch_begin(
    batch,
    logs=None
)

A backwards compatibility alias for on_train_batch_begin.

`tf.keras.callbacks.RemoteMonitor.on_batch_end`

on_batch_end(
    batch,
    logs=None
)

A backwards compatibility alias for on_train_batch_end.

`tf.keras.callbacks.RemoteMonitor.on_epoch_begin`

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.

Arguments:

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.

`tf.keras.callbacks.RemoteMonitor.on_epoch_end`

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.

Arguments:

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_.

`tf.keras.callbacks.RemoteMonitor.on_predict_batch_begin`

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.

Arguments:

batch: integer, index of batch within the current epoch.
logs: dict. Has keys batch and size representing the current batch number and the size of the batch.

`tf.keras.callbacks.RemoteMonitor.on_predict_batch_end`

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.

Arguments:

batch: integer, index of batch within the current epoch.
logs: dict. Metric results for this batch.

`tf.keras.callbacks.RemoteMonitor.on_predict_begin`

on_predict_begin(logs=None)

Called at the beginning of prediction.

Subclasses should override for any actions to run.

Arguments:

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

`tf.keras.callbacks.RemoteMonitor.on_predict_end`

on_predict_end(logs=None)

Called at the end of prediction.

Subclasses should override for any actions to run.

Arguments:

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

`tf.keras.callbacks.RemoteMonitor.on_test_batch_begin`

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 fit methods, if validation data is provided.

Subclasses should override for any actions to run.

Arguments:

batch: integer, index of batch within the current epoch.
logs: dict. Has keys batch and size representing the current batch number and the size of the batch.

`tf.keras.callbacks.RemoteMonitor.on_test_batch_end`

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 fit methods, if validation data is provided.

Subclasses should override for any actions to run.

Arguments:

batch: integer, index of batch within the current epoch.
logs: dict. Metric results for this batch.

`tf.keras.callbacks.RemoteMonitor.on_test_begin`

on_test_begin(logs=None)

Called at the beginning of evaluation or validation.

Subclasses should override for any actions to run.

Arguments:

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

`tf.keras.callbacks.RemoteMonitor.on_test_end`

on_test_end(logs=None)

Called at the end of evaluation or validation.

Subclasses should override for any actions to run.

Arguments:

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

`tf.keras.callbacks.RemoteMonitor.on_train_batch_begin`

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.

Arguments:

batch: integer, index of batch within the current epoch.
logs: dict. Has keys batch and size representing the current batch number and the size of the batch.

`tf.keras.callbacks.RemoteMonitor.on_train_batch_end`

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.

Arguments:

batch: integer, index of batch within the current epoch.
logs: dict. Metric results for this batch.

`tf.keras.callbacks.RemoteMonitor.on_train_begin`

on_train_begin(logs=None)

Called at the beginning of training.

Subclasses should override for any actions to run.

Arguments:

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

`tf.keras.callbacks.RemoteMonitor.on_train_end`

on_train_end(logs=None)

Called at the end of training.

Subclasses should override for any actions to run.

Arguments:

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

`tf.keras.callbacks.RemoteMonitor.set_model`

set_model(model)

`tf.keras.callbacks.RemoteMonitor.set_params`

set_params(params)