init

功能描述

初始化mxRec模型训练框架。

函数原型

def init(use_mpi, **kwargs)

参数说明

参数名	类型	可选/必选	说明
use_mpi	bool	必选	是否使用MPI并行计算框架。只能设置为“True”，当前不支持“False”。

**kwargs参数说明

参数名	类型	可选/必选	说明
train_steps	int	可选	进行测试预测的训练步数，默认值为“-1”，代表将训练数据集全部训练完后进行预测。取值范围：[-1, 2147483647]。
eval_steps	int	可选	测试预测步数，默认值为“-1”，代表将测试数据集全部预测完后继续训练。取值范围：[-1, 2147483647]。
if_load	bool	可选	选择是否进行模型加载，默认值为“False”。取值范围： True：进行模型加载 False：不进行模型加载
use_dynamic	bool	可选	是否使用动态shape功能，默认值“True”。取值范围： True：使用动态shape功能 False：不使用动态shape功能
use_hot	bool	可选	是否使用hot_embedding功能，默认值“True”。取值范围： True：使用hot_embedding功能 False：不使用hot_embedding功能
use_dynamic_expansion	bool	可选	是否使用动态扩容功能，默认值“False”。取值范围： True：使用动态扩容功能 False：不使用动态扩容功能
bind_cpu	bool	可选	是否使用自动CPU绑核功能，默认值“True”。取值范围： True：使用自动CPU绑核功能 False：不使用自动CPU绑核功能
save_steps	int	可选	训练save_step后进行保存，默认值“-1”，表示将训练数据全部训练完后进行保存，取值范围：[-1, 2147483647]。

如果通过kwargs传递其他未说明参数，则mxRec内部不会使用到该参数。
“train steps”和“eval steps”不能同时为“0”，且两者传入的参数需要与实际保持一致。
当“use_dynamic_expansion”动态扩容参数为True时，请选用ByAddr类的优化器，如SGDByAddr、LazyAdamByAddress等。
在train_and_evaluate场景下不支持多轮eval。

返回值说明

成功：None。
失败：抛出异常。

使用示例

from mx_rec.util.initialize import init
init(use_mpi=True, train_steps=100, eval_steps=10, save_steps=100, use_dynamic=True, use_hot=False, use_dynamic_expansion=False)

参考资源

接口调用流程及示例，请参见模型训练。

父主题： 训练框架初始化与去初始化