Refine readme #611

typhoonzero · 2018-02-08T10:40:40Z

gongweibao

Grammar plugin may be useful.

gongweibao · 2018-02-09T08:24:34Z

README.md

@@ -3,148 +3,88 @@
 [![Build Status](https://travis-ci.org/PaddlePaddle/cloud.svg?branch=develop)](https://travis-ci.org/PaddlePaddle/cloud)

 PaddlePaddle Cloud is a Distributed Deep-Learning Cloud Platform for both cloud
-providers and enterprises.
+providers and enterprises. PaddlePaddle Cloud provide cluster Deep-Learning


provide=>provides

gongweibao · 2018-02-09T08:24:52Z

README.md

+- Manage cluster Deep-Learning jobs use a command-line client very easily.
+- Elastic Deep-Learning ([EDL](./doc/edl/README.md)) enables maximizing cluster resource utilities
+  and reduce average job pending time.
+- Manages thousands of GPUs in cluster.


in cluster=>in a cluster

gongweibao · 2018-02-09T08:25:06Z

README.md

+- Elastic Deep-Learning ([EDL](./doc/edl/README.md)) enables maximizing cluster resource utilities
+  and reduce average job pending time.
+- Manages thousands of GPUs in cluster.
+- Fault tolerant distributed training with zero down time.


down time=>downtime

gongweibao · 2018-02-09T08:25:36Z

README.md

+- Elastic Deep-Learning ([EDL](./doc/edl/README.md)) enables maximizing cluster resource utilities
+  and reduce average job pending time.
+- Manages thousands of GPUs in cluster.
+- Fault tolerant distributed training with zero down time.

 PaddlePaddle Cloud use [Kubernetes](https://kubernetes.io) as it's backend job


gongweibao · 2018-02-09T08:25:58Z

README.md

-large scale GPU clusters.
-
-## Using Command-line To Submit Cloud Training Jobs
+as the deep-learning frame work. 


frame work=>framework

gongweibao · 2018-02-09T08:26:50Z

README.md

+
+- Server side components includes:
+  - Cloud Server
+    A REST API server accepts incomming request from lommand-line client, and submit


incomming=>incoming
lommand-line=>the command-line

gongweibao · 2018-02-09T08:28:37Z

README.md

+    A Kubernetes [Controller](https://kubernetes.io/docs/concepts/api-extension/custom-resources/#custom-controllers)
+    to enable automatically scale up/down jobs to maximize cluster performance.
+  - PaddlePaddle Cloud Job runtime Docker image.
+- Client side component:


Client side=>Client-side

gongweibao · 2018-02-09T08:29:07Z

README.md

+  - PaddlePaddle Cloud Job runtime Docker image.
+- Client side component:
+  - Command-Line client
+    Client for submit, list and kill cluster training jobs. Then code is under


submit=>submitting

gongweibao · 2018-02-09T08:29:29Z

README.md

+- Client side component:
+  - Command-Line client
+    Client for submit, list and kill cluster training jobs. Then code is under
+    `go/cmd/paddlecloud`, And, code under `go/cmd/paddlecloud` will deprecate and


gongweibao · 2018-02-09T08:29:45Z

README.md

+
+## User Manuals
+
+[快速开始](./doc/tutorial_cn.md)

 [中文手册](./doc/usage_cn.md)

 English tutorials(comming soon...)


Updated using Grammarly

gongweibao

Grammar plugin may be useful.

Yancey1989 · 2018-02-09T08:33:21Z

README.md

+  - Cloud Server
+    A REST API server accepts incomming request from lommand-line client, and submit
+    `TrainingJob` resource to Kubernetes cluster. Cloud Server is written using
+    `Django` framework under `python` directory.


Cloud you add a link for the python directory.

I use directory names in this section to prevent link change, detailed directory description can be found at the bottom.

Yancey1989 · 2018-02-09T08:35:13Z

README.md

+    `TrainingJob` resource to Kubernetes cluster. Cloud Server is written using
+    `Django` framework under `python` directory.
+  - PaddleFS
+    On cloud file management server used to upload user training job python programs,


I think Paddle FS is a general distributed file system on Cloud, so maybe it's not only used for training job python programs or trained models.

Added "etc."

Yancey1989 · 2018-02-09T08:36:53Z

README.md

-EMAIL_BACKEND = 'django_sendmail_backend.backends.EmailBackend'
+.
+├── demo: distributed version of https://github.com/PaddlePaddle/book programs
+├── doc: documents


I think there are two sub dir in doc, design and deploy

It's quite easy to understand what they are under the doc directory, so I omitted them.

wangkuiyi

Thank you @typhoonzero for this PR! I tried to make it slightly more concise in typhoonzero#1.

wangkuiyi · 2018-02-11T07:46:53Z

README.md

@@ -3,148 +3,88 @@
 [![Build Status](https://travis-ci.org/PaddlePaddle/cloud.svg?branch=develop)](https://travis-ci.org/PaddlePaddle/cloud)

 PaddlePaddle Cloud is a Distributed Deep-Learning Cloud Platform for both cloud
-providers and enterprises.
+providers and enterprises. PaddlePaddle Cloud provides cluster Deep-Learning


I think we can change this paragraph into:

PaddlePaddle Cloud is a combination of PaddlePaddle and Kubernetes. It supports fault-recoverable and fault-tolerant large-scaled distributed deep learning. We can deploy it on public cloud and on-premise clusters.

PaddlePaddle Cloud includes the following components:

wangkuiyi · 2018-02-11T07:50:21Z

README.md

+providers and enterprises. PaddlePaddle Cloud provides cluster Deep-Learning
+features including:
+
+- Manage cluster Deep-Learning jobs use a command-line client very easily.


paddlectl: A command-line tool that talks to paddlecloud, which in turn talks to Kbuernetes's API server.

paddlecloud: An HTTP server that is a portal of the deep learning cloud service. It exposes PaddlePaddle Cloud as a Web service.

EDL (elastic deep learning): A Kubernetes controller that supports elastic scheduling of deep learning jobs and other jobs.

Fault-tolerant distributed deep learning: This part is implemented in the Paddle repo.

Update README.md

Yancey1989 · 2018-02-11T08:19:18Z

doc/build.md

+
+## Build paddlectl client
+
+See [here](./build_edl_controller.md) to prepare Go and `glide` environment


Seems no ./build_edl_controller.md .

Yancey1989 · 2018-02-11T08:20:13Z

README.md

-./manage.py runserver
+PaddlePaddle Cloud is a combination of PaddlePaddle and Kubernetes. It
+supports fault-recoverable and fault-tolerant large-scaled distributed
+deep learning.  We can deploy it on public cloud and on-premise


A redundant blank space before the word We.

gongweibao

LGTM

gongweibao

LGTM

refine readme

a801c33

typhoonzero requested review from Yancey1989, wangkuiyi and gongweibao February 9, 2018 02:29

typhoonzero added 2 commits February 9, 2018 14:07

add folder tree

a459113

update build docs

b3c4d06

gongweibao reviewed Feb 9, 2018

View reviewed changes

gongweibao requested changes Feb 9, 2018

View reviewed changes

Yancey1989 reviewed Feb 9, 2018

View reviewed changes

fix grammar

a9d7145

typhoonzero requested a review from putcn February 11, 2018 07:42

Update README.md

97cc11a

wangkuiyi reviewed Feb 11, 2018

View reviewed changes

wangkuiyi and others added 2 commits February 11, 2018 00:08

Update

56f9cee

Merge pull request #1 from wangkuiyi/yi-refine-readme

ffdf05c

Update README.md

Yancey1989 reviewed Feb 11, 2018

View reviewed changes

gongweibao previously approved these changes Feb 11, 2018

View reviewed changes

typhoonzero added 2 commits February 23, 2018 09:22

Merge branch 'develop' into refine_readme

0c0a745

fix comments

585e9ba

typhoonzero dismissed gongweibao’s stale review via 585e9ba February 23, 2018 01:42

gongweibao approved these changes Feb 24, 2018

View reviewed changes

Merge branch 'develop' into refine_readme

cf3f80c

typhoonzero merged commit 735177d into PaddlePaddle:develop Feb 24, 2018

typhoonzero deleted the refine_readme branch February 24, 2018 02:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refine readme #611

Refine readme #611

typhoonzero commented Feb 8, 2018

gongweibao left a comment

gongweibao Feb 9, 2018

gongweibao Feb 9, 2018

gongweibao Feb 9, 2018

gongweibao Feb 9, 2018

gongweibao Feb 9, 2018

gongweibao Feb 9, 2018

gongweibao Feb 9, 2018

gongweibao Feb 9, 2018

gongweibao Feb 9, 2018

gongweibao Feb 9, 2018

typhoonzero Feb 9, 2018

gongweibao left a comment

Yancey1989 Feb 9, 2018

typhoonzero Feb 9, 2018

Yancey1989 Feb 9, 2018

typhoonzero Feb 9, 2018

Yancey1989 Feb 9, 2018

typhoonzero Feb 9, 2018

wangkuiyi left a comment

wangkuiyi Feb 11, 2018

wangkuiyi Feb 11, 2018

Yancey1989 Feb 11, 2018

Yancey1989 Feb 11, 2018

gongweibao left a comment

gongweibao left a comment


		## Build paddlectl client

		See [here](./build_edl_controller.md) to prepare Go and `glide` environment

Refine readme #611

Refine readme #611

Conversation

typhoonzero commented Feb 8, 2018

gongweibao left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gongweibao left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wangkuiyi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gongweibao left a comment

Choose a reason for hiding this comment

gongweibao left a comment

Choose a reason for hiding this comment