[](LICENSE) [](https://github.com/PaddlePaddle/PaddleRec/releases) PaddleRec是源于飞桨生态的搜索推荐模型一站式开箱即用工具，无论您是初学者，开发者，研究者均可便捷的使用PaddleRec完成调研，训练到预测部署的全流程工作。PaddleRec提供了搜索推荐任务中语义理解、召回、粗排、精排、多任务学习的全流程解决方案。 PadlleRec以预置模型为核心,具备以下特点： - [易于上手，开箱即用](https://www.paddlepaddle.org.cn) - [灵活配置，个性调参](https://www.paddlepaddle.org.cn) - [分布式训练，大规模稀疏](https://www.paddlepaddle.org.cn) - [快速部署，一键上线](https://www.paddlepaddle.org.cn)

# 目录 * [特性](#特性) * [支持模型列表](#支持模型列表) * [文档教程](#文档教程) * [入门教程](#入门教程) * [环境要求](#环境要求) * [安装命令](#安装命令) * [快速开始](#快速开始) * [常见问题FAQ](#常见问题faq) * [进阶教程](#进阶教程) * [自定义数据集及Reader](#自定义数据集及reader) * [模型调参](#模型调参) * [单机训练](#单机训练) * [分布式训练](#分布式训练) * [预测部署](#预测部署) * [版本历史](#版本历史) * [版本更新](#版本更新) * [Benchamrk](#benchamrk) * [许可证书](#许可证书) * [如何贡献代码](#如何贡献代码) * [优化PaddleRec框架](#优化paddlerec框架) * [新增模型到PaddleRec](#新增模型到paddlerec) # 特性 - 易于上手，开箱即用 - 灵活配置，个性调参 - 分布式训练，大规模稀疏 - 快速部署，一键上线 # 支持模型列表 | 方向 | 模型 | 单机CPU训练 | 单机GPU训练 | 分布式CPU训练 | 大规模稀疏 | 分布式GPU训练 | 自定义数据集 | | :------: | :--------------------: | :---------: | :---------: | :-----------: | :--------: | :-----------: | :----------: | | 内容理解 | [Text-Classifcation]() | ✓ | x | ✓ | x | ✓ | ✓ | | 内容理解 | [TagSpace]() | ✓ | x | ✓ | x | ✓ | ✓ | | 召回 | [Word2Vec]() | ✓ | x | ✓ | x | ✓ | ✓ | | 召回 | [TDM]() | ✓ | x | ✓ | x | ✓ | ✓ | | 排序 | [CTR-Dnn]() | ✓ | x | ✓ | x | ✓ | ✓ | | 排序 | [DeepFm]() | ✓ | x | ✓ | x | ✓ | ✓ | | 排序 | [ListWise]() | ✓ | x | ✓ | x | ✓ | ✓ | | 多任务 | [MMOE]() | ✓ | x | ✓ | x | ✓ | ✓ | | 多任务 | [ESMM]() | ✓ | x | ✓ | x | ✓ | ✓ | | 匹配 | [DSSM]() | ✓ | x | ✓ | x | ✓ | ✓ | | 匹配 | [Multiview-Simnet]() | ✓ | x | ✓ | x | ✓ | ✓ | # 文档教程 ## 入门教程 ### 环境要求 * Python >= 2.7 * PaddlePaddle >= 1.7.2 * 操作系统: Windows/Mac/Linux ### 安装命令 - 安装方法一： ```bash python -m pip install fleet-rec ``` - 安装方法二 * 安装飞桨 **注：需要用户安装最新版本的飞桨<当前只支持Linux系统>。** ```bash python -m pip install paddlepaddle -i https://mirror.baidu.com/pypi/simple ``` * 源码安装Fleet-Rec ``` git clone https://github.com/seiriosPlus/FleetRec/ cd FleetRec python setup.py install ``` ### 快速开始 #### ctr-dnn示例使用 目前框架内置了多个模型，简单的命令即可使用内置模型开始单机训练和本地1*1模拟训练 ##### 单机训练 ```bash cd FleetRec python -m fleetrec.run \ -m fleetrec.models.rank.dnn \ -d cpu \ -e single # 使用GPU资源进行训练 python -m fleetrec.run \ -m fleetrec.models.rank.dnn \ -d gpu \ -e single ``` ##### 本地模拟分布式训练 ```bash cd FleetRec # 使用CPU资源进行训练 python -m fleetrec.run \ -m fleetrec.models.rank.dnn \ -d cpu \ -e local_cluster ``` ##### 集群提交分布式训练<需要用户预先配置好集群环境，本提交命令不包含提交客户端> ```bash cd FleetRec python -m fleetrec.run \ -m fleetrec.models.rank.dnn \ -d cpu \ -e cluster ``` ### 常见问题FAQ # 版本历史 ## 版本更新 # 许可证书 本项目的发布受[Apache 2.0 license](LICENSE)许可认证。