paddlets.models.common.callbacks.callbacks

class Callback

基类：object

用于构建新Callback的抽象基类.

_trainer

模型实例.

类型

PaddleBaseModel

set_trainer(model: PaddleBaseModel)

设置模型实例.

参数

model (PaddleBaseModel) – 模型实例.

on_epoch_begin(epoch: int, logs: Optional[Dict[str, Any]] = None)

在每个epoch开始前调用.

参数

• epoch (int) – epoch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_epoch_end(epoch: int, logs: Optional[Dict[str, Any]] = None)

在每个epoch结束后调用.

参数

• epoch (int) – epoch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_batch_begin(batch: int, logs: Optional[Dict[str, Any]] = None)

在每个batch开始前调用.

参数

• batch (int) – batch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_batch_end(batch: int, logs: Optional[Dict[str, Any]] = None)

在每个batch结束后调用.

参数

• batch (int) – batch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_train_begin(logs: Optional[Dict[str, Any]] = None)

在模型训练开始前调用.

参数

logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_train_end(logs: Optional[Dict[str, Any]] = None)

在模型训练结束后调用.

参数

logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

class CallbackContainer(callbacks: List[Callback])

基类：object

包含若干Callback的容器.

参数

callbacks (List[Callback]) – Callback的列表.

_callbacks

Callback的列表.

类型

List[Callback]

append(callback: Callback)

向容器里追加Callback.

参数

callback (Callback) – Callback实例.

set_trainer(model: PaddleBaseModel)

设置模型实例.

参数

model (PaddleBaseModel) – 模型实例.

on_epoch_begin(epoch: int, logs: Optional[Dict[str, Any]] = None)

在每个epoch开始前调用.

参数

• epoch (int) – epoch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_epoch_end(epoch: int, logs: Optional[Dict[str, Any]] = None)

在每个epoch结束后调用.

参数

• epoch (int) – epoch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_batch_begin(batch: int, logs: Optional[Dict[str, Any]] = None)

在每个batch开始前调用.

参数

• batch (int) – batch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_batch_end(batch: int, logs: Optional[Dict[str, Any]] = None)

在每个batch结束后调用.

参数

• batch (int) – batch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_train_begin(logs: Optional[Dict[str, Any]] = None)

在模型训练开始前调用.

参数

logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_train_end(logs: Optional[Dict[str, Any]] = None)

在模型训练结束后调用.

参数

logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

class EarlyStopping(early_stopping_metric: str, is_maximize: bool, tol: float = 0.0, patience: int = 1)

基类：Callback

EarlyStopping Callback(早停), 在训练过程中, 当提供的metric不再变优，让模型提前停止训练.

参数

• early_stopping_metric (str) – 用于EarlyStopping(早停)的metric名称.

• is_maximize (bool) – 标识early_stopping_metric的优化方向.

• tol (float) – 标识early_stopping_metric需要提升的最小delta值.

• patience (int) – 训练结束前early_stopping_metric没有提升的次数.

_early_stopping_metric

用于EarlyStopping(早停)的metric名称.

类型

str

_is_maximize

标识early_stopping_metric的优化方向.

类型

bool

_tol

标识early_stopping_metric需要提升的最小delta值.

类型

float

_patience

训练结束前early_stopping_metric没有提升的次数.

类型

int

_best_epoch

模型达到最优的epoch索引.

类型

int

_stopped_epoch

模型停止训练时的epoch索引.

类型

int

_best_loss

训练结束时, 模型所能达到的最优early_stopping_metric(反应模型当前的表现).

类型

float

_wait

训练结束前early_stopping_metric没有提升的次数.

类型

int

on_epoch_end(epoch: int, logs: Optional[Dict[str, Any]] = None)

在每个epoch结束后调用.

参数

• epoch (int) – epoch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_train_end(logs: Optional[Dict[str, Any]] = None)

在模型训练结束后调用.

参数

logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

class History(verbose: int = 1)

基类：Callback

History Callback, 记录模型训练过程中各种信息.

参数

verbose (int) – 设定打印信息的迭代间隔.

_verbose

设定打印信息的迭代间隔.

类型

int

_history

记录模型训练过程中各类metric信息.

类型

Dict[str, Any]

_start_time

训练开始时刻.

类型

float

_epoch_loss

模型训练时, 每一轮的平均loss.

类型

float

_epoch_metrics

记录模型训练过程中各类metric信息.

类型

Dict[str, Any]

_samples_seen

遍历的样本数目.

类型

int

on_train_begin(logs: Optional[Dict[str, Any]] = None)

在模型训练开始前调用.

参数

logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_epoch_begin(epoch: int, logs: Optional[Dict[str, Any]] = None)

在每个epoch开始前调用.

参数

• epoch (int) – epoch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_epoch_end(epoch: int, logs: Optional[Dict[str, Any]] = None)

在每个epoch结束后调用.

参数

• epoch (int) – epoch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.

on_batch_end(batch: int, logs: Optional[Dict[str, Any]] = None)

在每个batch结束后调用.

参数

• batch (int) – batch的索引.

• logs (Dict[str, Any]|None) – 日志信息, 可以是字典或者None.