提交 591b48aa 编写于 作者: C chengmo

update readme

上级 2fed2cdf
# 快速开始
## 环境准备
Fleet-Rec是基于飞桨分布式训练所开发的,包含模型、训练模式的快速开发、调试、部署的工具, 让用户更轻松的使用飞桨分布式训练。
- 安装方法一<PIP源直接安装>
```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模拟训练
<p align="center">
<img align="center" src="doc/imgs/logo.png">
<p>
[![License](https://img.shields.io/badge/license-Apache%202-red.svg)](LICENSE)
[![Version](https://img.shields.io/github/v/release/PaddlePaddle/Paddle.svg)](https://github.com/PaddlePaddle/PaddleRec/releases)
![python version](https://img.shields.io/badge/python-2.7+-orange.svg)
![support os](https://img.shields.io/badge/os-linux%2C%20win%2C%20mac-yellow.svg)
`PaddleRec`是源于飞桨生态的`搜索推荐模型`一站式开箱即用工具,无论您是初学者,开发者,研究者均可便捷的使用`PaddleRec`完成调研,训练到预测部署的全流程工作。`PaddleRec`提供了搜索推荐任务中语义理解、召回、粗排、精排、多任务学习的全流程解决方案。
`PadlleRec`以预置模型为核心,具备以下特点:
> 占位链接,分文档描述
- [易于上手,开箱即用](https://www.paddlepaddle.org.cn)
- [灵活配置,个性调参](https://www.paddlepaddle.org.cn)
- [分布式训练,大规模稀疏](https://www.paddlepaddle.org.cn)
- [快速部署,一键上线](https://www.paddlepaddle.org.cn)
<p align="center">
<img align="center" src="doc/imgs/coding-gif.png">
<p>
# 目录
* [特性](#特性)
* [易于上手,开箱即用](#易于上手开箱即用)
* [灵活配置,个性调参](#灵活配置个性调参)
* [分布式训练,大规模稀疏](#分布式训练大规模稀疏)
* [快速部署,一键上线](#快速部署一键上线)
* [支持模型列表](#支持模型列表)
* [文档教程](#文档教程)
* [入门教程](#入门教程)
* [环境要求](#环境要求)
* [安装命令](#安装命令)
* [快速开始](#快速开始)
* [常见问题FAQ](#常见问题faq)
* [进阶教程](#进阶教程)
* [自定义数据集及Reader](#自定义数据集及reader)
* [模型调参](#模型调参)
* [单机训练](#单机训练)
* [分布式训练](#分布式训练)
* [预测部署](#预测部署)
* [版本历史](#版本历史)
* [版本更新](#版本更新)
* [Benchamrk](#benchamrk)
* [许可证书](#许可证书)
* [如何贡献代码](#如何贡献代码)
* [优化PaddleRec框架](#优化paddlerec框架)
* [新增模型到PaddleRec](#新增模型到paddlerec)
# 特性
## 易于上手,开箱即用
## 灵活配置,个性调参
## 分布式训练,大规模稀疏
## 快速部署,一键上线
# 支持模型列表
# 文档教程
## 入门教程
### 环境要求
### 安装命令
### 快速开始
### 常见问题FAQ
## 进阶教程
### 自定义数据集及Reader
### 模型调参
### 单机训练
```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
```
# 版本历史
## 版本更新
## Benchamrk
# 许可证书
更多用户文档及二次开发文档,敬请期待。
\ No newline at end of file
# 如何贡献代码
## 优化PaddleRec框架
## 新增模型到PaddleRec
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册