训练

回调

class Callback(iteration, epoch)

基类：object

回调函数基类

classmethod by_name(name)

通过注册的名字取得实际的类型

参数

name – 注册的名字

返回

Type[T] 使用 name 注册的子类

返回类型

class

引发

RegistrationError – 如果 name 未被注册

classmethod from_params(__config, *args, extra=None, **kwargs)

使用 config 生成对象

参数

• cls – 类型

• __config – 配置项，通常为字典，形如 {‘class’:’ClassName’, ‘init’:{ ‘arg’: arg } }

• *args – 直接传入的arg

• extra – 根据需要传入的数据

• **kwargs – 其他参数

返回

根据参数生成的对象

classmethod hook(hook)

函数装饰器，给某个类注册装饰器

classmethod is_registered(name)

如果 name 在类中已经注册，则返回 True

classmethod iter_registered()

迭代已经注册的名字和对象

classmethod list_available()

列出所有的注册子类

classmethod register(name, override=False, hooks=None)

装饰器 Class decorator for registering a subclass.

参数

• name – 注册名

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks (List[HookType]) – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

classmethod weak_register(name, subclass, override=False, hooks=None)

用于手动对子类进行注册

参数

• name (str) – 子类的引用名

• subclass – 子类类型

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

class CsvWriter(iteration, epoch, save_directory='./log', filename='log.csv', delimiter=', ', extra_header=None, data_extractor=<function CsvWriter.<lambda>>)

基类：ltp.train.callback.Callback

class TensorboardCallback(iteration, epoch, save_directory='./log', main_tag='tensorboard', data_extractor=<function TensorboardCallback.<lambda>>)

基类：ltp.train.callback.Callback

损失

class Loss(*args, **kwargs)

基类：torch.nn.modules.loss._Loss

forward(*input, **kwargs)

Defines the computation performed at every call.

Should be overridden by all subclasses.

注解

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

classmethod by_name(name)

通过注册的名字取得实际的类型

参数

name – 注册的名字

返回

Type[T] 使用 name 注册的子类

返回类型

class

引发

RegistrationError – 如果 name 未被注册

classmethod from_params(__config, *args, extra=None, **kwargs)

使用 config 生成对象

参数

• cls – 类型

• __config – 配置项，通常为字典，形如 {‘class’:’ClassName’, ‘init’:{ ‘arg’: arg } }

• *args – 直接传入的arg

• extra – 根据需要传入的数据

• **kwargs – 其他参数

返回

根据参数生成的对象

classmethod hook(hook)

函数装饰器，给某个类注册装饰器

classmethod is_registered(name)

如果 name 在类中已经注册，则返回 True

classmethod iter_registered()

迭代已经注册的名字和对象

classmethod list_available()

列出所有的注册子类

classmethod register(name, override=False, hooks=None)

装饰器 Class decorator for registering a subclass.

参数

• name – 注册名

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks (List[HookType]) – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

classmethod weak_register(name, subclass, override=False, hooks=None)

用于手动对子类进行注册

参数

• name (str) – 子类的引用名

• subclass – 子类类型

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

优化器

class Optimizer(params, defaults)

基类：torch.optim.optimizer.Optimizer

classmethod by_name(name)

通过注册的名字取得实际的类型

参数

name – 注册的名字

返回

Type[T] 使用 name 注册的子类

返回类型

class

引发

RegistrationError – 如果 name 未被注册

classmethod from_params(__config, *args, extra=None, **kwargs)

使用 config 生成对象

参数

• cls – 类型

• __config – 配置项，通常为字典，形如 {‘class’:’ClassName’, ‘init’:{ ‘arg’: arg } }

• *args – 直接传入的arg

• extra – 根据需要传入的数据

• **kwargs – 其他参数

返回

根据参数生成的对象

classmethod hook(hook)

函数装饰器，给某个类注册装饰器

classmethod is_registered(name)

如果 name 在类中已经注册，则返回 True

classmethod iter_registered()

迭代已经注册的名字和对象

classmethod list_available()

列出所有的注册子类

classmethod register(name, override=False, hooks=None)

装饰器 Class decorator for registering a subclass.

参数

• name – 注册名

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks (List[HookType]) – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

classmethod weak_register(name, subclass, override=False, hooks=None)

用于手动对子类进行注册

参数

• name (str) – 子类的引用名

• subclass – 子类类型

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

调度器

class Scheduler(optimizer, last_epoch=- 1)

基类：torch.optim.lr_scheduler._LRScheduler

调度器

classmethod by_name(name)

通过注册的名字取得实际的类型

参数

name – 注册的名字

返回

Type[T] 使用 name 注册的子类

返回类型

class

引发

RegistrationError – 如果 name 未被注册

classmethod from_params(__config, *args, extra=None, **kwargs)

使用 config 生成对象

参数

• cls – 类型

• __config – 配置项，通常为字典，形如 {‘class’:’ClassName’, ‘init’:{ ‘arg’: arg } }

• *args – 直接传入的arg

• extra – 根据需要传入的数据

• **kwargs – 其他参数

返回

根据参数生成的对象

classmethod hook(hook)

函数装饰器，给某个类注册装饰器

classmethod is_registered(name)

如果 name 在类中已经注册，则返回 True

classmethod iter_registered()

迭代已经注册的名字和对象

classmethod list_available()

列出所有的注册子类

classmethod register(name, override=False, hooks=None)

装饰器 Class decorator for registering a subclass.

参数

• name – 注册名

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks (List[HookType]) – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

classmethod weak_register(name, subclass, override=False, hooks=None)

用于手动对子类进行注册

参数

• name (str) – 子类的引用名

• subclass – 子类类型

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

class TemperatureScheduler

基类：object

蒸馏温度调度器

classmethod by_name(name)

通过注册的名字取得实际的类型

参数

name – 注册的名字

返回

Type[T] 使用 name 注册的子类

返回类型

class

引发

RegistrationError – 如果 name 未被注册

classmethod from_params(__config, *args, extra=None, **kwargs)

使用 config 生成对象

参数

• cls – 类型

• __config – 配置项，通常为字典，形如 {‘class’:’ClassName’, ‘init’:{ ‘arg’: arg } }

• *args – 直接传入的arg

• extra – 根据需要传入的数据

• **kwargs – 其他参数

返回

根据参数生成的对象

classmethod hook(hook)

函数装饰器，给某个类注册装饰器

classmethod is_registered(name)

如果 name 在类中已经注册，则返回 True

classmethod iter_registered()

迭代已经注册的名字和对象

classmethod list_available()

列出所有的注册子类

classmethod register(name, override=False, hooks=None)

装饰器 Class decorator for registering a subclass.

参数

• name – 注册名

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks (List[HookType]) – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

classmethod weak_register(name, subclass, override=False, hooks=None)

用于手动对子类进行注册

参数

• name (str) – 子类的引用名

• subclass – 子类类型

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

停止条件

class NoStopping

基类：object

永不停止

class EarlyStopping(patience=None, metric=None, float_rounding=None)

基类：object

早停止

检查点

class CheckpointPlugin(directory=None, filename=None)

基类：object

Checkpoint

参数

• directory – 存放目录

• filename – 检查点文件名

classmethod by_name(name)

通过注册的名字取得实际的类型

参数

name – 注册的名字

返回

Type[T] 使用 name 注册的子类

返回类型

class

引发

RegistrationError – 如果 name 未被注册

classmethod from_params(__config, *args, extra=None, **kwargs)

使用 config 生成对象

参数

• cls – 类型

• __config – 配置项，通常为字典，形如 {‘class’:’ClassName’, ‘init’:{ ‘arg’: arg } }

• *args – 直接传入的arg

• extra – 根据需要传入的数据

• **kwargs – 其他参数

返回

根据参数生成的对象

classmethod hook(hook)

函数装饰器，给某个类注册装饰器

classmethod is_registered(name)

如果 name 在类中已经注册，则返回 True

classmethod iter_registered()

迭代已经注册的名字和对象

classmethod list_available()

列出所有的注册子类

classmethod register(name, override=False, hooks=None)

装饰器 Class decorator for registering a subclass.

参数

• name – 注册名

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks (List[HookType]) – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

classmethod weak_register(name, subclass, override=False, hooks=None)

用于手动对子类进行注册

参数

• name (str) – 子类的引用名

• subclass – 子类类型

• override (bool) – 当name已经注册时，是否进行覆盖

• hooks – 在注册时会被执行的Hook函数

引发

RegistrationError – 如果 override 为 false 并且 name 已经被注册

class LoadCheckpointPlugin(directory=None, filename=None)

基类：ltp.train.checkpoint.CheckpointPlugin

class BestCheckpointPlugin(metric, directory=None, filename=None)

基类：ltp.train.checkpoint.CheckpointPlugin

class RestoreCheckpointPlugin(*args, **kwargs)

基类：ltp.train.checkpoint.CheckpointPlugin