From 6a915b7ee9fa27baadc993dec7586b53f7e8b78b Mon Sep 17 00:00:00 2001
From: tangwei <tangwei12@baidu.com>
Date: Thu, 16 Apr 2020 00:04:31 +0800
Subject: [PATCH] add readme

---
 readme.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 00000000..bc32e94d
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,49 @@
+(QUICK_STARTED.md) | 简体中文
+
+# 快速开始
+
+## 环境准备
+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示例使用
+目前框架内置了ctr-dnn模型，后续会加入更多模型
+
+示例代码位于FleetRec/fleetrec/example/下， 当前支持单机训练和本地1*1模拟训练
+
+### 单机训练
+```bash
+cd FleetRec
+
+python -m fleetrec.run \
+       --model fleetrec/examples/build_in/ctr-dnn_train.yaml 
+       --engine single
+
+
+```
+
+### 本地模拟分布式训练
+
+```bash
+cd FleetRec
+
+python -m fleetrec.run \
+       --model fleetrec/examples/build_in/ctr-dnn_train.yaml 
+       --engine local_cluster
+
+```
+
+更多用户文档及二次开发文档，敬请期待。
\ No newline at end of file
-- 
GitLab