PaddleRS/docs/apis/train.md

PaddleRS训练API说明

训练器封装了模型训练、验证、量化以及动态图推理等逻辑，定义在paddlers/tasks/目录下的文件中。为了方便用户使用，PaddleRS为所有支持的模型均提供了继承自父类BaseModel的训练器，并对外提供数个API。变化检测、场景分类、目标检测、图像复原以及图像分割任务对应的训练器类型分别为BaseChangeDetector、BaseClassifier、BaseDetector、BaseRestorer和BaseSegmenter。本文档介绍训练器的初始化函数以及train()、evaluate() API。

初始化训练器

所有训练器均支持默认参数构造（即构造对象时不传入任何参数），在这种情况下，构造出的训练器对象适用于三通道RGB数据。

初始化BaseChangeDetector子类对象

• 一般支持设置num_classes、use_mixed_loss以及in_channels参数，分别表示模型输出类别数、是否使用预置的混合损失以及输入通道数。部分子类如DSIFN暂不支持对in_channels参数的设置。
• use_mixed_loss参将在未来被弃用，因此不建议使用。
• 可通过losses参数指定模型训练时使用的损失函数。losses需为一个字典，其中'types'键和'coef'键对应的值为两个等长的列表，分别表示损失函数对象（一个可调用对象）和损失函数的权重。例如：losses={'types': [LossType1(), LossType2()], 'coef': [1.0, 0.5]}在训练过程中将等价于计算如下损失函数：1.0*LossType1()(logits, labels)+0.5*LossType2()(logits, labels)，其中logits和labels分别是模型输出和真值标签。
• 不同的子类支持与模型相关的输入参数，详情请参考模型定义和训练器定义。

初始化BaseClassifier子类对象

• 一般支持设置num_classes和use_mixed_loss参数，分别表示模型输出类别数以及是否使用预置的混合损失。
• use_mixed_loss参将在未来被弃用，因此不建议使用。
• 可通过losses参数指定模型训练时使用的损失函数，传入实参需为paddlers.models.clas_losses.CombinedLoss类型对象。
• 不同的子类支持与模型相关的输入参数，详情请参考模型定义和训练器定义。

初始化BaseDetector子类对象

• 一般支持设置num_classes和backbone参数，分别表示模型输出类别数以及所用的骨干网络类型。相比其它任务，目标检测任务的训练器支持设置的初始化参数较多，囊括网络结构、损失函数、后处理策略等方面。
• 与分割、分类、变化检测等任务不同，检测任务不支持通过losses参数指定损失函数。不过对于部分训练器如PPYOLO，可通过use_iou_loss等参数定制损失函数。
• 不同的子类支持与模型相关的输入参数，详情请参考模型定义和训练器定义。

初始化BaseRestorer子类对象

• 一般支持设置sr_factor参数，表示超分辨率倍数；对于不支持超分辨率重建任务的模型，sr_factor设置为None。
• 可通过losses参数指定模型训练时使用的损失函数，传入实参需为可调用对象或字典。手动指定的losses与子类的default_loss()方法返回值必须具有相同的格式。
• 可通过min_max参数指定模型输入、输出的数值范围；若为None，则使用类默认的数值范围。
• 不同的子类支持与模型相关的输入参数，详情请参考模型定义和训练器定义。

初始化BaseSegmenter子类对象

• 一般支持设置in_channels、num_classes以及use_mixed_loss参数，分别表示输入通道数、输出类别数以及是否使用预置的混合损失。
• use_mixed_loss参将在未来被弃用，因此不建议使用。
• 可通过losses参数指定模型训练时使用的损失函数。losses需为一个字典，其中'types'键和'coef'键对应的值为两个等长的列表，分别表示损失函数对象（一个可调用对象）和损失函数的权重。例如：losses={'types': [LossType1(), LossType2()], 'coef': [1.0, 0.5]}在训练过程中将等价于计算如下损失函数：1.0*LossType1()(logits, labels)+0.5*LossType2()(logits, labels)，其中logits和labels分别是模型输出和真值标签。
• 不同的子类支持与模型相关的输入参数，详情请参考模型定义和训练器定义。

train()

BaseChangeDetector.train()

接口形式：

def train(self,
          num_epochs,
          train_dataset,
          train_batch_size=2,
          eval_dataset=None,
          optimizer=None,
          save_interval_epochs=1,
          log_interval_steps=2,
          save_dir='output',
          pretrain_weights=None,
          learning_rate=0.01,
          lr_decay_power=0.9,
          early_stop=False,
          early_stop_patience=5,
          use_vdl=True,
          resume_checkpoint=None):

其中各参数的含义如下：

参数名称	类型	参数说明	默认值
num_epochs	int	训练的epoch数目。
train_dataset	paddlers.datasets.CDDataset	训练数据集。
train_batch_size	int	训练时使用的batch size。	2
eval_dataset	paddlers.datasets.CDDataset | None	验证数据集。	None
optimizer	paddle.optimizer.Optimizer | None	训练时使用的优化器。若为None，则使用默认定义的优化器。	None
save_interval_epochs	int	训练时存储模型的间隔epoch数。	1
log_interval_steps	int	训练时打印日志的间隔step数（即迭代数）。	2
save_dir	str	存储模型的路径。	'output'
pretrain_weights	str | None	预训练权重的名称/路径。若为None，则不适用预训练权重。	None
learning_rate	float	训练时使用的学习率大小，适用于默认优化器。	0.01
lr_decay_power	float	学习率衰减系数，适用于默认优化器。	0.9
early_stop	bool	训练过程是否启用早停策略。	False
early_stop_patience	int	启用早停策略时的patience参数（参见EarlyStop）。	5
use_vdl	bool	是否启用VisualDL日志。	True
resume_checkpoint	str | None	检查点路径。PaddleRS支持从检查点（包含先前训练过程中存储的模型权重和优化器权重）继续训练，但需注意resume_checkpoint与pretrain_weights不得同时设置为None以外的值。	None

BaseClassifier.train()

接口形式：

def train(self,
          num_epochs,
          train_dataset,
          train_batch_size=2,
          eval_dataset=None,
          optimizer=None,
          save_interval_epochs=1,
          log_interval_steps=2,
          save_dir='output',
          pretrain_weights='IMAGENET',
          learning_rate=0.1,
          lr_decay_power=0.9,
          early_stop=False,
          early_stop_patience=5,
          use_vdl=True,
          resume_checkpoint=None):

其中各参数的含义如下：

参数名称	类型	参数说明	默认值
num_epochs	int	训练的epoch数目。
train_dataset	paddlers.datasets.ClasDataset	训练数据集。
train_batch_size	int	训练时使用的batch size。	2
eval_dataset	paddlers.datasets.ClasDataset | None	验证数据集。	None
optimizer	paddle.optimizer.Optimizer | None	训练时使用的优化器。若为None，则使用默认定义的优化器。	None
save_interval_epochs	int	训练时存储模型的间隔epoch数。	1
log_interval_steps	int	训练时打印日志的间隔step数（即迭代数）。	2
save_dir	str	存储模型的路径。	'output'
pretrain_weights	str | None	预训练权重的名称/路径。若为None，则不适用预训练权重。	'IMAGENET'
learning_rate	float	训练时使用的学习率大小，适用于默认优化器。	0.1
lr_decay_power	float	学习率衰减系数，适用于默认优化器。	0.9
early_stop	bool	训练过程是否启用早停策略。	False
early_stop_patience	int	启用早停策略时的patience参数（参见EarlyStop）。	5
use_vdl	bool	是否启用VisualDL日志。	True
resume_checkpoint	str | None	检查点路径。PaddleRS支持从检查点（包含先前训练过程中存储的模型权重和优化器权重）继续训练，但需注意resume_checkpoint与pretrain_weights不得同时设置为None以外的值。	None

BaseDetector.train()

接口形式：

def train(self,
          num_epochs,
          train_dataset,
          train_batch_size=64,
          eval_dataset=None,
          optimizer=None,
          save_interval_epochs=1,
          log_interval_steps=10,
          save_dir='output',
          pretrain_weights='IMAGENET',
          learning_rate=.001,
          warmup_steps=0,
          warmup_start_lr=0.0,
          lr_decay_epochs=(216, 243),
          lr_decay_gamma=0.1,
          metric=None,
          use_ema=False,
          early_stop=False,
          early_stop_patience=5,
          use_vdl=True,
          resume_checkpoint=None):

其中各参数的含义如下：

参数名称	类型	参数说明	默认值
num_epochs	int	训练的epoch数目。
train_dataset	paddlers.datasets.COCODetDataset | paddlers.datasets.VOCDetDataset	训练数据集。
train_batch_size	int	训练时使用的batch size（多卡训练时，为所有设备合计batch size）。	64
eval_dataset	paddlers.datasets.COCODetDataset | paddlers.datasets.VOCDetDataset | None	验证数据集。	None
optimizer	paddle.optimizer.Optimizer | None	训练时使用的优化器。若为None，则使用默认定义的优化器。	None
save_interval_epochs	int	训练时存储模型的间隔epoch数。	1
log_interval_steps	int	训练时打印日志的间隔step数（即迭代数）。	10
save_dir	str	存储模型的路径。	'output'
pretrain_weights	str | None	预训练权重的名称/路径。若为None，则不适用预训练权重。	'IMAGENET'
learning_rate	float	训练时使用的学习率大小，适用于默认优化器。	0.001
warmup_steps	int	默认优化器使用warm-up策略的预热轮数。	0
warmup_start_lr	int	默认优化器warm-up阶段使用的初始学习率。	0
lr_decay_epochs	list | tuple	默认优化器学习率衰减的milestones，以epoch计。即，在第几个epoch执行学习率的衰减。	(216, 243)
lr_decay_gamma	float	学习率衰减系数，适用于默认优化器。	0.1
metric	str | None	评价指标，可以为'VOC'、COCO或None。若为Nnoe，则根据数据集格式自动确定使用的评价指标。	None
use_ema	bool	是否启用指数滑动平均策略更新模型权重参数。	False
early_stop	bool	训练过程是否启用早停策略。	False
early_stop_patience	int	启用早停策略时的patience参数（参见EarlyStop）。	5
use_vdl	bool	是否启用VisualDL日志。	True
resume_checkpoint	str | None	检查点路径。PaddleRS支持从检查点（包含先前训练过程中存储的模型权重和优化器权重）继续训练，但需注意resume_checkpoint与pretrain_weights不得同时设置为None以外的值。	None

BaseRestorer.train()

接口形式：

def train(self,
          num_epochs,
          train_dataset,
          train_batch_size=2,
          eval_dataset=None,
          optimizer=None,
          save_interval_epochs=1,
          log_interval_steps=2,
          save_dir='output',
          pretrain_weights='CITYSCAPES',
          learning_rate=0.01,
          lr_decay_power=0.9,
          early_stop=False,
          early_stop_patience=5,
          use_vdl=True,
          resume_checkpoint=None):

其中各参数的含义如下：

参数名称	类型	参数说明	默认值
num_epochs	int	训练的epoch数目。
train_dataset	paddlers.datasets.ResDataset	训练数据集。
train_batch_size	int	训练时使用的batch size。	2
eval_dataset	paddlers.datasets.ResDataset | None	验证数据集。	None
optimizer	paddle.optimizer.Optimizer | None	训练时使用的优化器。若为None，则使用默认定义的优化器。	None
save_interval_epochs	int	训练时存储模型的间隔epoch数。	1
log_interval_steps	int	训练时打印日志的间隔step数（即迭代数）。	2
save_dir	str	存储模型的路径。	'output'
pretrain_weights	str | None	预训练权重的名称/路径。若为None，则不适用预训练权重。	'CITYSCAPES'
learning_rate	float	训练时使用的学习率大小，适用于默认优化器。	0.01
lr_decay_power	float	学习率衰减系数，适用于默认优化器。	0.9
early_stop	bool	训练过程是否启用早停策略。	False
early_stop_patience	int	启用早停策略时的patience参数（参见EarlyStop）。	5
use_vdl	bool	是否启用VisualDL日志。	True
resume_checkpoint	str | None	检查点路径。PaddleRS支持从检查点（包含先前训练过程中存储的模型权重和优化器权重）继续训练，但需注意resume_checkpoint与pretrain_weights不得同时设置为None以外的值。	None

BaseSegmenter.train()

接口形式：

def train(self,
          num_epochs,
          train_dataset,
          train_batch_size=2,
          eval_dataset=None,
          optimizer=None,
          save_interval_epochs=1,
          log_interval_steps=2,
          save_dir='output',
          pretrain_weights='CITYSCAPES',
          learning_rate=0.01,
          lr_decay_power=0.9,
          early_stop=False,
          early_stop_patience=5,
          use_vdl=True,
          resume_checkpoint=None):

其中各参数的含义如下：

参数名称	类型	参数说明	默认值
num_epochs	int	训练的epoch数目。
train_dataset	paddlers.datasets.SegDataset	训练数据集。
train_batch_size	int	训练时使用的batch size。	2
eval_dataset	paddlers.datasets.SegDataset | None	验证数据集。	None
optimizer	paddle.optimizer.Optimizer | None	训练时使用的优化器。若为None，则使用默认定义的优化器。	None
save_interval_epochs	int	训练时存储模型的间隔epoch数。	1
log_interval_steps	int	训练时打印日志的间隔step数（即迭代数）。	2
save_dir	str	存储模型的路径。	'output'
pretrain_weights	str | None	预训练权重的名称/路径。若为None，则不适用预训练权重。	'CITYSCAPES'
learning_rate	float	训练时使用的学习率大小，适用于默认优化器。	0.01
lr_decay_power	float	学习率衰减系数，适用于默认优化器。	0.9
early_stop	bool	训练过程是否启用早停策略。	False
early_stop_patience	int	启用早停策略时的patience参数（参见EarlyStop）。	5
use_vdl	bool	是否启用VisualDL日志。	True
resume_checkpoint	str | None	检查点路径。PaddleRS支持从检查点（包含先前训练过程中存储的模型权重和优化器权重）继续训练，但需注意resume_checkpoint与pretrain_weights不得同时设置为None以外的值。	None

evaluate()

BaseChangeDetector.evaluate()

接口形式：

def evaluate(self, eval_dataset, batch_size=1, return_details=False):

输入参数如下：

参数名称	类型	参数说明	默认值
eval_dataset	paddlers.datasets.CDDataset	评估数据集。
batch_size	int	评估时使用的batch size（多卡训练时，为所有设备合计batch size）。	1
return_details	bool	是否返回详细信息。	False

当return_details为False（默认行为）时，输出为一个collections.OrderedDict对象。对于二类变化检测任务，输出包含如下键值对：

{"iou": 变化类的IoU指标,
 "f1": 变化类的F1分数,
 "oacc": 总体精度（准确率）,
 "kappa": kappa系数}

对于多类变化检测任务，输出包含如下键值对：

{"miou": mIoU指标,
 "category_iou": 各类的IoU指标,
 "oacc": 总体精度（准确率）,
 "category_acc": 各类精确率,
 "kappa": kappa系数,
 "category_F1score": 各类F1分数}

当return_details为True时，返回一个由两个字典构成的二元组，其中第一个元素为上述评价指标，第二个元素为仅包含一个key的字典，其'confusion_matrix'键对应值为以Python built-in list存储的混淆矩阵。

BaseClassifier.evaluate()

接口形式：

def evaluate(self, eval_dataset, batch_size=1, return_details=False):

输入参数如下：

参数名称	类型	参数说明	默认值
eval_dataset	paddlers.datasets.ClasDataset	评估数据集。
batch_size	int	评估时使用的batch size（多卡训练时，为所有设备合计batch size）。	1
return_details	bool	当前版本请勿手动设置此参数。	False

输出为一个collections.OrderedDict对象，包含如下键值对：

{"top1": top1准确率,
 "top5": top5准确率}

BaseDetector.evaluate()

接口形式：

def evaluate(self,
             eval_dataset,
             batch_size=1,
             metric=None,
             return_details=False):

输入参数如下：

参数名称	类型	参数说明	默认值
eval_dataset	paddlers.datasets.COCODetDataset | paddlers.datasets.VOCDetDataset	评估数据集。
batch_size	int	评估时使用的batch size（多卡训练时，为所有设备合计batch size）。	1
metric	str | None	评价指标，可以为'VOC'、COCO或None。若为Nnoe，则根据数据集格式自动确定使用的评价指标。	None
return_details	bool	是否返回详细信息。	False

当return_details为False（默认行为）时，输出为一个collections.OrderedDict对象，包含如下键值对：

{"bbox_mmap": 预测结果的mAP值}

当return_details为True时，返回一个由两个字典构成的二元组，其中第一个字典为上述评价指标，第二个字典包含如下3个键值对：

{"gt": 数据集标注信息,
 "bbox": 预测得到的目标框信息,
 "mask": 预测得到的掩模图信息}

BaseRestorer.evaluate()

接口形式：

def evaluate(self, eval_dataset, batch_size=1, return_details=False):

输入参数如下：

参数名称	类型	参数说明	默认值
eval_dataset	paddlers.datasets.ResDataset	评估数据集。
batch_size	int	评估时使用的batch size（多卡训练时，为所有设备合计batch size）。	1
return_details	bool	当前版本请勿手动设置此参数。	False

输出为一个collections.OrderedDict对象，包含如下键值对：

{"psnr": PSNR指标,
 "ssim": SSIM指标}

BaseSegmenter.evaluate()

接口形式：

def evaluate(self, eval_dataset, batch_size=1, return_details=False):

输入参数如下：

参数名称	类型	参数说明	默认值
eval_dataset	paddlers.datasets.SegDataset	评估数据集。
batch_size	int	评估时使用的batch size（多卡训练时，为所有设备合计batch size）。	1
return_details	bool	是否返回详细信息。	False

当return_details为False（默认行为）时，输出为一个collections.OrderedDict对象，包含如下键值对：

{"miou": mIoU指标,
 "category_iou": 各类的IoU指标,
 "oacc": 总体精度（准确率）,
 "category_acc": 各类精确率,
 "kappa": kappa系数,
 "category_F1score": 各类F1分数}

当return_details为True时，返回一个由两个字典构成的二元组，其中第一个元素为上述评价指标，第二个元素为仅包含一个key的字典，其'confusion_matrix'键对应值为以Python built-in list存储的混淆矩阵。