Add english tutorials #621

Yancey1989 · 2018-02-11T11:31:24Z

Related #594

putcn · 2018-02-12T03:52:24Z

doc/tutorial.md

@@ -0,0 +1,175 @@
+# Getting Started with Submitting Job


"Submitting Job" => "Submitting Training Jobs"

putcn · 2018-02-12T03:53:35Z

doc/tutorial.md

+
+## Download and Configure paddlectl
+
+`paddlectl` is a command-line tool that submits distributed training job to the cloud.


"submits distributed training job to the cloud" => "submits distributed training jobs to the paddle cloud"

putcn · 2018-02-12T04:06:49Z

doc/tutorial.md

+
+- Step1
+
+  Download `paddlectl` and copy the binary file to the folder which under


Download paddlectl to your system $PATH directory, and make it executable by running the command below

chmod +x paddlectl

Stable paddlectl binary can be found from the Release Page.

Or if you wish to try the latest one from our CI, please find the URLs from the table below for different OSs.

putcn · 2018-02-12T04:07:45Z

doc/tutorial.md

+
+- Step2
+
+  Configurate the configuration file `~/.paddle/config` (`./paddle\config`


"Configurate the configuration file" => "Edit the configuration file"

putcn · 2018-02-12T04:15:14Z

doc/tutorial.md

+  current-datacenter: production
+  ```
+
+  Supports you have two data-center's access, one for `production` and another one for


"Supports" => "We suppose"

putcn · 2018-02-12T04:18:24Z

doc/tutorial.md

+  ```
+
+  Supports you have two data-center's access, one for `production` and another one for
+  `experimentation`, you can choose one data-center by the `current-datacenter` field


"you can choose one data-center by the current-datacenter field for the current one." => "you can select your current data-center by editing current-datacenter field"

putcn · 2018-02-12T04:20:24Z

doc/tutorial.md

+
+  Configurate the configuration file `~/.paddle/config` (`./paddle\config`
+  under current user folder for Windows),
+  an example is as following:


Paddlectl supports adding multi data-center settings and switch between them on the fly. An example configuration is as follows:

putcn · 2018-02-12T04:21:35Z

doc/tutorial.md

+  `experimentation`, you can choose one data-center by the `current-datacenter` field
+  for the current one.
+
+  `username`, `password` and `endpoint` is your secret for the data-center, you will


"is your secret for the data-center" => "is your credential for accessing the data-center"

putcn · 2018-02-12T04:22:49Z

doc/tutorial.md

+  for the current one.
+
+  `username`, `password` and `endpoint` is your secret for the data-center, you will
+  received an email including your secret information send by the administrator.


"receive an email with your credential from paddle cloud administrator"

putcn · 2018-02-12T04:24:05Z

doc/tutorial.md

+  `username`, `password` and `endpoint` is your secret for the data-center, you will
+  received an email including your secret information send by the administrator.
+
+After finish the two steps above, execute `paddlectl` command will print the usage:


"After finish the two steps above" => "With completion of the two steps above"

putcn · 2018-02-12T04:24:44Z

doc/tutorial.md

+Use "paddlectl flags" for a list of top-level flags
+```
+
+## Download the Demo Code and Try to Submit it


"Code" => "Projects"

putcn · 2018-02-12T04:25:57Z

doc/tutorial.md

+
+## Download the Demo Code and Try to Submit it
+
+We prepare some demo code to help users understanding how to submit


"We prepare some demo code to help users understanding how to submit" => "We prepared some demo projects to help users understand how to submit"

putcn · 2018-02-12T04:26:34Z

doc/tutorial.md

+on [Paddle Book](/~https://github.com/Paddlepaddle/book), you can find the
+tutorials for each chapter.
+
+You can fetch the demo code and submit the job as the following command:


"as" => "with"

putcn · 2018-02-12T04:34:48Z

doc/tutorial.md

+> paddlecloud submit -jobname fit-a-line -cpu 1 -gpu 1 -parallelism 1 -entry "python train.py train" fit_a_line/
+```
+
+For each submits arguments:


"For each submits arguments:" => "Options:"

putcn · 2018-02-12T04:39:45Z

doc/tutorial.md

+- `./fit_a_line`, STRING, the local directory including job package.
+
+**NOTE1**: You can find the whole usage by `paddlectl submit -h`.
+**NOTE2**: Submit the job by different jobname, so that the previous jobs data would be saved on the cloud.


"jobname" = "jobnames"

putcn · 2018-02-12T04:39:45Z

doc/tutorial.md

+- `-entry`, STRING, the entry point for the training job.
+- `./fit_a_line`, STRING, the local directory including job package.
+
+**NOTE1**: You can find the whole usage by `paddlectl submit -h`.


"whole" => "complete"

putcn · 2018-02-12T04:59:27Z

doc/tutorial.md

+- `./fit_a_line`, STRING, the local directory including job package.
+
+**NOTE1**: You can find the whole usage by `paddlectl submit -h`.
+**NOTE2**: Submit the job by different jobname, so that the previous jobs data would be saved on the cloud.


"so that the previous jobs data would be saved on the cloud." => "so that it does not conflict with previous job with the same name"

putcn · 2018-02-12T05:00:38Z

doc/tutorial.md

+- `SUCC`, the number for finished training node.
+- `FAIL`, the number for failed training node.
+
+Then, you can view the logs of job(only running or finished status) by `paddelctl logs`


"logs of job" => "logs of a job"

putcn · 2018-02-12T05:02:05Z

doc/tutorial.md

+```
+
+`paddlectl logs` will return the last 10 lines by default, you can also
+use `-n <number>` argument to print the last number lines.


"number lines" => "<number> of lines"

putcn · 2018-02-12T05:04:10Z

doc/tutorial.md

+
+## Clean the Training Job
+
+The following command will clean the training job, after that, you could check


"could" => "can't" ?

putcn · 2018-02-12T05:04:29Z

doc/tutorial.md

+## Clean the Training Job
+
+The following command will clean the training job, after that, you could check
+the logs, but you can find the output on


"the output on" => "the output from"

putcn

please see inline comments, thanks!

Yancey1989 · 2018-03-01T04:49:53Z

FROM @putcn

please see inline comments, thanks!

Thanks for reviewing! Updated by comments.

putcn

LGTM!

Add english tutorials

9baab95

Yancey1989 requested review from wangkuiyi, typhoonzero and putcn February 11, 2018 11:31

putcn reviewed Feb 12, 2018

View reviewed changes

doc/tutorial.md Outdated

@@ -0,0 +1,175 @@

# Getting Started with Submitting Job

Copy link

putcn Feb 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Submitting Job" => "Submitting Training Jobs"

putcn reviewed Feb 12, 2018

View reviewed changes

putcn suggested changes Feb 12, 2018

View reviewed changes

update by comment

cef220d

putcn approved these changes Mar 1, 2018

View reviewed changes

Merge branch 'develop' into refine_tutorials

43b3497

Merge branch 'develop' into refine_tutorials

df5ae96

Yancey1989 merged commit 1596ddf into PaddlePaddle:develop Mar 2, 2018

Yancey1989 deleted the refine_tutorials branch March 2, 2018 02:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add english tutorials #621

Add english tutorials #621

Yancey1989 commented Feb 11, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn Feb 12, 2018 •

edited

Loading

putcn Feb 12, 2018

putcn Feb 12, 2018

putcn left a comment

Yancey1989 commented Mar 1, 2018

putcn left a comment


		## Download and Configure paddlectl

		`paddlectl` is a command-line tool that submits distributed training job to the cloud.


		- Step1

		Download `paddlectl` and copy the binary file to the folder which under


		- Step2

		Configurate the configuration file `~/.paddle/config` (`./paddle\config`


		## Download the Demo Code and Try to Submit it

		We prepare some demo code to help users understanding how to submit


		## Clean the Training Job

		The following command will clean the training job, after that, you could check

Add english tutorials #621

Add english tutorials #621

Conversation

Yancey1989 commented Feb 11, 2018

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

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

putcn Feb 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

putcn left a comment

Choose a reason for hiding this comment

Yancey1989 commented Mar 1, 2018

putcn left a comment

Choose a reason for hiding this comment

putcn Feb 12, 2018 •

edited

Loading