def train_net(network,
train_path,
num_classes,
batch_size,
data_shape,
mean_pixels,
resume,
finetune,
pretrained,
epoch,
prefix,
ctx,
begin_epoch,
end_epoch,
frequent,
learning_rate,
momentum,
weight_decay,
lr_refactor_step,
lr_refactor_ratio,
freeze_layer_pattern='',
num_example=10000,
label_pad_width=350,
nms_thresh=0.45,
force_nms=False,
ovp_thresh=0.5,
use_difficult=False,
class_names=None,
voc07_metric=False,
nms_topk=400,
force_suppress=False,
train_list="",
val_path="",
val_list="",
iter_monitor=0,
monitor_pattern=".*",
log_file=None,
optimizer='sgd',
tensorboard=False,
checkpoint_period=5,
min_neg_samples=0):
"""
Wrapper for training phase.
Parameters:
----------
net : str
symbol name for the network structure
train_path : str
record file path for training
num_classes : int
number of object classes, not including background
batch_size : int
training batch-size
data_shape : int or tuple
width/height as integer or (3, height, width) tuple
mean_pixels : tuple of floats
mean pixel values for red, green and blue
resume : int
resume from previous checkpoint if > 0
finetune : int
fine-tune from previous checkpoint if > 0
pretrained : str
prefix of pretrained model, including path
epoch : int
load epoch of either resume/finetune/pretrained model
prefix : str
prefix for saving checkpoints
ctx : [mx.cpu()] or [mx.gpu(x)]
list of mxnet contexts
begin_epoch : int
starting epoch for training, should be 0 if not otherwise specified
end_epoch : int
end epoch of training
frequent : int
frequency to print out training status
optimizer : str
usage of different optimizers, other then default sgd
learning_rate : float
training learning rate
momentum : float
trainig momentum
weight_decay : float
training weight decay param
lr_refactor_ratio : float
multiplier for reducing learning rate
lr_refactor_step : comma separated integers
at which epoch to rescale learning rate, e.g. '30, 60, 90'
freeze_layer_pattern : str
regex pattern for layers need to be fixed
num_example : int
number of training images
label_pad_width : int
force padding training and validation labels to sync their label widths
nms_thresh : float
non-maximum suppression threshold for validation
force_nms : boolean
suppress overlaped objects from different classes
train_list : str
list file path for training, this will replace the embeded labels in record
val_path : str
record file path for validation
val_list : str
list file path for validation, this will replace the embeded labels in record
iter_monitor : int
monitor internal stats in networks if > 0, specified by monitor_pattern
monitor_pattern : str
regex pattern for monitoring network stats
log_file : str
log to file if enabled
tensorboard : bool
record logs into tensorboard
min_neg_samples : int
always have some negative examples, no matter how many positive there are.
this is useful when training on images with no ground-truth.
checkpoint_period : int
a checkpoint will be saved every "checkpoint_period" epochs
"""
# check actual number of train_images
if os.path.exists(train_path.replace('rec', 'idx')):
with open(train_path.replace('rec', 'idx'), 'r') as f:
txt = f.readlines()
num_example = len(txt)
# set up logger
logging.basicConfig()
logger = logging.getLogger()
logger.setLevel(logging.INFO)
if log_file:
log_file_path = os.path.join(os.path.dirname(prefix), log_file)
if not os.path.exists(os.path.dirname(log_file_path)):
os.makedirs(os.path.dirname(log_file_path))
fh = logging.FileHandler(log_file_path)
logger.addHandler(fh)
# check args
if isinstance(data_shape, int):
data_shape = (3, data_shape, data_shape)
assert len(data_shape) == 3 and data_shape[0] == 3
if prefix.endswith('_'):
prefix += '_' + str(data_shape[1])
if isinstance(mean_pixels, (int, float)):
mean_pixels = [mean_pixels, mean_pixels, mean_pixels]
assert len(mean_pixels) == 3, "must provide all RGB mean values"
train_iter = DetRecordIter(train_path,
batch_size,
data_shape,
mean_pixels=mean_pixels,
label_pad_width=label_pad_width,
path_imglist=train_list,
**cfg.train)
if val_path:
val_iter = DetRecordIter(val_path,
batch_size,
data_shape,
mean_pixels=mean_pixels,
label_pad_width=label_pad_width,
path_imglist=val_list,
**cfg.valid)
else:
val_iter = None
# load symbol
net = get_symbol_train(network,
data_shape[1],
num_classes=num_classes,
nms_thresh=nms_thresh,
force_suppress=force_suppress,
nms_topk=nms_topk,
minimum_negative_samples=min_neg_samples)
# define layers with fixed weight/bias
if freeze_layer_pattern.strip():
re_prog = re.compile(freeze_layer_pattern)
fixed_param_names = [
name for name in net.list_arguments() if re_prog.match(name)
]
else:
fixed_param_names = None
# load pretrained or resume from previous state
ctx_str = '(' + ','.join([str(c) for c in ctx]) + ')'
if resume > 0:
logger.info("Resume training with {} from epoch {}".format(
ctx_str, resume))
_, args, auxs = mx.model.load_checkpoint(prefix, resume)
begin_epoch = resume
elif finetune > 0:
logger.info("Start finetuning with {} from epoch {}".format(
ctx_str, finetune))
# _, args, auxs = mx.model.load_checkpoint(prefix, finetune)
# Gang Chen changed
_, args, auxs = mx.model.load_checkpoint(pretrained, finetune)
begin_epoch = finetune
# check what layers mismatch with the loaded parameters
exe = net.simple_bind(mx.cpu(),
data=(1, 3, 300, 300),
label=(1, 1, 5),
grad_req='null')
arg_dict = exe.arg_dict
fixed_param_names = []
for k, v in arg_dict.items():
if k in args:
if v.shape != args[k].shape:
del args[k]
logging.info("Removed %s" % k)
else:
if not 'pred' in k:
#Gang Chen
#fixed_param_names.append(k)
pass
elif pretrained and not finetune:
logger.info("Start training with {} from pretrained model {}".format(
ctx_str, pretrained))
_, args, auxs = mx.model.load_checkpoint(pretrained, epoch)
args = convert_pretrained(pretrained, args)
else:
logger.info("Experimental: start training from scratch with {}".format(
ctx_str))
args = None
auxs = None
fixed_param_names = None
# helper information
if fixed_param_names:
logger.info("Freezed parameters: [" + ','.join(fixed_param_names) +
']')
# visualize net - both train and test
net_visualization(net=net,
network=network,
data_shape=data_shape[2],
output_dir=os.path.dirname(prefix),
train=True)
'''
net_visualization(net=None, network=network, data_shape=data_shape[2],
output_dir=os.path.dirname(prefix), train=False, num_classes=num_classes)
'''
# init training module
mod = mx.mod.Module(net,
label_names=('label', ),
logger=logger,
context=ctx,
fixed_param_names=fixed_param_names)
batch_end_callback = []
eval_end_callback = []
epoch_end_callback = [
mx.callback.do_checkpoint(prefix, period=checkpoint_period)
]
# add logging to tensorboard
if tensorboard:
tensorboard_dir = os.path.join(os.path.dirname(prefix), 'logs')
if not os.path.exists(tensorboard_dir):
os.makedirs(os.path.join(tensorboard_dir, 'train', 'scalar'))
os.makedirs(os.path.join(tensorboard_dir, 'train', 'dist'))
os.makedirs(os.path.join(tensorboard_dir, 'val', 'roc'))
os.makedirs(os.path.join(tensorboard_dir, 'val', 'scalar'))
os.makedirs(os.path.join(tensorboard_dir, 'val', 'images'))
batch_end_callback.append(
ParseLogCallback(
dist_logging_dir=os.path.join(tensorboard_dir, 'train',
'dist'),
scalar_logging_dir=os.path.join(tensorboard_dir, 'train',
'scalar'),
logfile_path=log_file_path,
batch_size=batch_size,
iter_monitor=iter_monitor,
frequent=frequent))
eval_end_callback.append(
mx.contrib.tensorboard.LogMetricsCallback(
os.path.join(tensorboard_dir, 'val/scalar'), 'ssd'))
eval_end_callback.append(
LogROCCallback(logging_dir=os.path.join(tensorboard_dir,
'val/roc'),
roc_path=os.path.join(os.path.dirname(prefix),
'roc'),
class_names=class_names))
eval_end_callback.append(
LogDetectionsCallback(
logging_dir=os.path.join(tensorboard_dir, 'val/images'),
images_path=os.path.join(os.path.dirname(prefix), 'images'),
class_names=class_names,
batch_size=batch_size,
mean_pixels=mean_pixels))
# this callback should be the last in a serie of batch_callbacks
# since it is resetting the metric evaluation every $frequent batches
batch_end_callback.append(
mx.callback.Speedometer(train_iter.batch_size, frequent=frequent))
learning_rate, lr_scheduler = get_lr_scheduler(learning_rate,
lr_refactor_step,
lr_refactor_ratio,
num_example, batch_size,
begin_epoch)
# add possibility for different optimizer
opt, opt_params = get_optimizer_params(optimizer=optimizer,
learning_rate=learning_rate,
momentum=momentum,
weight_decay=weight_decay,
lr_scheduler=lr_scheduler,
ctx=ctx,
logger=logger)
# TODO monitor the gradient flow as in 'https://github.com/dmlc/tensorboard/blob/master/docs/tutorial/understanding-vanish-gradient.ipynb'
monitor = mx.mon.Monitor(
iter_monitor, pattern=monitor_pattern) if iter_monitor > 0 else None
# run fit net, every n epochs we run evaluation network to get mAP
if voc07_metric:
valid_metric = VOC07MApMetric(ovp_thresh,
use_difficult,
class_names,
pred_idx=3,
roc_output_path=os.path.join(
os.path.dirname(prefix), 'roc'))
else:
valid_metric = MApMetric(ovp_thresh,
use_difficult,
class_names,
pred_idx=3,
roc_output_path=os.path.join(
os.path.dirname(prefix), 'roc'))
mod.fit(train_iter,
val_iter,
eval_metric=MultiBoxMetric(),
validation_metric=valid_metric,
batch_end_callback=batch_end_callback,
eval_end_callback=eval_end_callback,
epoch_end_callback=epoch_end_callback,
optimizer=opt,
optimizer_params=opt_params,
begin_epoch=begin_epoch,
num_epoch=end_epoch,
initializer=mx.init.Xavier(),
arg_params=args,
aux_params=auxs,
allow_missing=True,
monitor=monitor)
def train_net(network, train_path, num_classes, batch_size,
data_shape, mean_pixels, resume, finetune, pretrained, epoch,
prefix, ctx, begin_epoch, end_epoch, frequent, learning_rate,
momentum, weight_decay, lr_refactor_step, lr_refactor_ratio,
freeze_layer_pattern='',
num_example=10000, label_pad_width=350,
nms_thresh=0.45, force_nms=False, ovp_thresh=0.5,
use_difficult=False, class_names=None,
voc07_metric=False, nms_topk=400, force_suppress=False,
train_list="", val_path="", val_list="", iter_monitor=0,
monitor_pattern=".*", log_file=None, optimizer='sgd', tensorboard=False,
checkpoint_period=5, min_neg_samples=0):
"""
Wrapper for training phase.
Parameters:
----------
net : str
symbol name for the network structure
train_path : str
record file path for training
num_classes : int
number of object classes, not including background
batch_size : int
training batch-size
data_shape : int or tuple
width/height as integer or (3, height, width) tuple
mean_pixels : tuple of floats
mean pixel values for red, green and blue
resume : int
resume from previous checkpoint if > 0
finetune : int
fine-tune from previous checkpoint if > 0
pretrained : str
prefix of pretrained model, including path
epoch : int
load epoch of either resume/finetune/pretrained model
prefix : str
prefix for saving checkpoints
ctx : [mx.cpu()] or [mx.gpu(x)]
list of mxnet contexts
begin_epoch : int
starting epoch for training, should be 0 if not otherwise specified
end_epoch : int
end epoch of training
frequent : int
frequency to print out training status
optimizer : str
usage of different optimizers, other then default sgd
learning_rate : float
training learning rate
momentum : float
trainig momentum
weight_decay : float
training weight decay param
lr_refactor_ratio : float
multiplier for reducing learning rate
lr_refactor_step : comma separated integers
at which epoch to rescale learning rate, e.g. '30, 60, 90'
freeze_layer_pattern : str
regex pattern for layers need to be fixed
num_example : int
number of training images
label_pad_width : int
force padding training and validation labels to sync their label widths
nms_thresh : float
non-maximum suppression threshold for validation
force_nms : boolean
suppress overlaped objects from different classes
train_list : str
list file path for training, this will replace the embeded labels in record
val_path : str
record file path for validation
val_list : str
list file path for validation, this will replace the embeded labels in record
iter_monitor : int
monitor internal stats in networks if > 0, specified by monitor_pattern
monitor_pattern : str
regex pattern for monitoring network stats
log_file : str
log to file if enabled
tensorboard : bool
record logs into tensorboard
min_neg_samples : int
always have some negative examples, no matter how many positive there are.
this is useful when training on images with no ground-truth.
checkpoint_period : int
a checkpoint will be saved every "checkpoint_period" epochs
"""
# check actual number of train_images
if os.path.exists(train_path.replace('rec','idx')):
with open(train_path.replace('rec','idx'), 'r') as f:
txt = f.readlines()
num_example = len(txt)
# set up logger
logging.basicConfig()
logger = logging.getLogger()
logger.setLevel(logging.INFO)
if log_file:
log_file_path = os.path.join(os.path.dirname(prefix), log_file)
if not os.path.exists(os.path.dirname(log_file_path)):
os.makedirs(os.path.dirname(log_file_path))
fh = logging.FileHandler(log_file_path)
logger.addHandler(fh)
# check args
if isinstance(data_shape, int):
data_shape = (3, data_shape, data_shape)
assert len(data_shape) == 3 and data_shape[0] == 3
if prefix.endswith('_'):
prefix += '_' + str(data_shape[1])
if isinstance(mean_pixels, (int, float)):
mean_pixels = [mean_pixels, mean_pixels, mean_pixels]
assert len(mean_pixels) == 3, "must provide all RGB mean values"
train_iter = DetRecordIter(train_path, batch_size, data_shape, mean_pixels=mean_pixels,
label_pad_width=label_pad_width, path_imglist=train_list, **cfg.train)
if val_path:
val_iter = DetRecordIter(val_path, batch_size, data_shape, mean_pixels=mean_pixels,
label_pad_width=label_pad_width, path_imglist=val_list, **cfg.valid)
else:
val_iter = None
# load symbol
net = get_symbol_train(network, data_shape[1], num_classes=num_classes,
nms_thresh=nms_thresh, force_suppress=force_suppress, nms_topk=nms_topk, minimum_negative_samples=min_neg_samples)
# define layers with fixed weight/bias
if freeze_layer_pattern.strip():
re_prog = re.compile(freeze_layer_pattern)
fixed_param_names = [name for name in net.list_arguments() if re_prog.match(name)]
else:
fixed_param_names = None
# load pretrained or resume from previous state
ctx_str = '(' + ','.join([str(c) for c in ctx]) + ')'
if resume > 0:
logger.info("Resume training with {} from epoch {}"
.format(ctx_str, resume))
_, args, auxs = mx.model.load_checkpoint(prefix, resume)
begin_epoch = resume
elif finetune > 0:
logger.info("Start finetuning with {} from epoch {}"
.format(ctx_str, finetune))
_, args, auxs = mx.model.load_checkpoint(prefix, finetune)
begin_epoch = finetune
# check what layers mismatch with the loaded parameters
exe = net.simple_bind(mx.cpu(), data=(1, 3, 300, 300), label=(1, 1, 5), grad_req='null')
arg_dict = exe.arg_dict
fixed_param_names = []
for k, v in arg_dict.items():
if k in args:
if v.shape != args[k].shape:
del args[k]
logging.info("Removed %s" % k)
else:
if not 'pred' in k:
fixed_param_names.append(k)
elif pretrained:
logger.info("Start training with {} from pretrained model {}"
.format(ctx_str, pretrained))
_, args, auxs = mx.model.load_checkpoint(pretrained, epoch)
args = convert_pretrained(pretrained, args)
else:
logger.info("Experimental: start training from scratch with {}"
.format(ctx_str))
args = None
auxs = None
fixed_param_names = None
# helper information
if fixed_param_names:
logger.info("Freezed parameters: [" + ','.join(fixed_param_names) + ']')
# visualize net - both train and test
net_visualization(net=net, network=network,data_shape=data_shape[2],
output_dir=os.path.dirname(prefix), train=True)
net_visualization(net=None, network=network, data_shape=data_shape[2],
output_dir=os.path.dirname(prefix), train=False, num_classes=num_classes)
# init training module
mod = mx.mod.Module(net, label_names=('label',), logger=logger, context=ctx,
fixed_param_names=fixed_param_names)
batch_end_callback = []
eval_end_callback = []
epoch_end_callback = [mx.callback.do_checkpoint(prefix, period=checkpoint_period)]
# add logging to tensorboard
if tensorboard:
tensorboard_dir = os.path.join(os.path.dirname(prefix), 'logs')
if not os.path.exists(tensorboard_dir):
os.makedirs(os.path.join(tensorboard_dir, 'train', 'scalar'))
os.makedirs(os.path.join(tensorboard_dir, 'train', 'dist'))
os.makedirs(os.path.join(tensorboard_dir, 'val', 'roc'))
os.makedirs(os.path.join(tensorboard_dir, 'val', 'scalar'))
os.makedirs(os.path.join(tensorboard_dir, 'val', 'images'))
batch_end_callback.append(
ParseLogCallback(dist_logging_dir=os.path.join(tensorboard_dir, 'train', 'dist'),
scalar_logging_dir=os.path.join(tensorboard_dir, 'train', 'scalar'),
logfile_path=log_file_path, batch_size=batch_size, iter_monitor=iter_monitor,
frequent=frequent))
eval_end_callback.append(mx.contrib.tensorboard.LogMetricsCallback(
os.path.join(tensorboard_dir, 'val/scalar'), 'ssd'))
eval_end_callback.append(LogROCCallback(logging_dir=os.path.join(tensorboard_dir, 'val/roc'),
roc_path=os.path.join(os.path.dirname(prefix), 'roc'),
class_names=class_names))
eval_end_callback.append(LogDetectionsCallback(logging_dir=os.path.join(tensorboard_dir, 'val/images'),
images_path=os.path.join(os.path.dirname(prefix), 'images'),
class_names=class_names,batch_size=batch_size,mean_pixels=mean_pixels))
# this callback should be the last in a serie of batch_callbacks
# since it is resetting the metric evaluation every $frequent batches
batch_end_callback.append(mx.callback.Speedometer(train_iter.batch_size, frequent=frequent))
learning_rate, lr_scheduler = get_lr_scheduler(learning_rate, lr_refactor_step,
lr_refactor_ratio, num_example, batch_size, begin_epoch)
# add possibility for different optimizer
opt, opt_params = get_optimizer_params(optimizer=optimizer, learning_rate=learning_rate, momentum=momentum,
weight_decay=weight_decay, lr_scheduler=lr_scheduler, ctx=ctx, logger=logger)
# TODO monitor the gradient flow as in 'https://github.com/dmlc/tensorboard/blob/master/docs/tutorial/understanding-vanish-gradient.ipynb'
monitor = mx.mon.Monitor(iter_monitor, pattern=monitor_pattern) if iter_monitor > 0 else None
# run fit net, every n epochs we run evaluation network to get mAP
if voc07_metric:
valid_metric = VOC07MApMetric(ovp_thresh, use_difficult, class_names, pred_idx=3,
roc_output_path=os.path.join(os.path.dirname(prefix), 'roc'))
else:
valid_metric = MApMetric(ovp_thresh, use_difficult, class_names, pred_idx=3,
roc_output_path=os.path.join(os.path.dirname(prefix), 'roc'))
mod.fit(train_iter,
val_iter,
eval_metric=MultiBoxMetric(),
validation_metric=valid_metric,
batch_end_callback=batch_end_callback,
eval_end_callback=eval_end_callback,
epoch_end_callback=epoch_end_callback,
optimizer=opt,
optimizer_params=opt_params,
begin_epoch=begin_epoch,
num_epoch=end_epoch,
initializer=mx.init.Xavier(),
arg_params=args,
aux_params=auxs,
allow_missing=True,
monitor=monitor)
