in_backward_optimizer_filter（TorchRec）

此接口为TorchRec开源接口，非Rec SDK Torch对外接口。此章节介绍使用Rec SDK Torch时调用的TorchRec接口支持的参数范围。

功能描述

过滤掉被指定为backward_optimizer的参数。

函数原型

def in_backward_optimizer_filter(
    named_parameters: Iterator[Tuple[str, nn.Parameter]], include: bool = False
) -> Iterator[Tuple[str, nn.Parameter]]:

参数说明

参数名	类型	可选/必选	说明
named_parameters	Iterator[Tuple[str, nn.Parameter]]	必选	模型的参数列表。用户需自行保证该变量是通过torch.nn.Module的named_parameters()获得
include	bool	可选	如果include为True，返回的结果包含backward_optimizer的参数名，否则不包含。默认值为False。 True：包含 False：不包含

参数名

类型

可选/必选

说明

named_parameters

Iterator[Tuple[str, nn.Parameter]]

必选

模型的参数列表。

用户需自行保证该变量是通过torch.nn.Module的named_parameters()获得

include

bool

可选

如果include为True，返回的结果包含backward_optimizer的参数名，否则不包含。默认值为False。

True：包含
False：不包含

返回值说明

成功：返回过滤后的参数。
失败：抛出异常。

使用示例

from torchrec.optim.optimizers import in_backward_optimizer_filter
parameter = in_backward_optimizer_filter(model.named_parameters())

参考资源

接口调用流程及示例可参见迁移与训练。

父主题： 优化器接口