-
Notifications
You must be signed in to change notification settings - Fork 548
Refine document for new user to submit job #2278
Conversation
squirrelsc
commented
Mar 6, 2019
- New guidance to submit job.
- Refine homepage to connect with new guidance.
- Reorganize content of troubleshooting for next refactoring.
- Fix some links.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did not finish all the files review, looks good in general, approved with minor comments.
docs/user/training.md
Outdated
|
||
## Submit a hello-world job | ||
|
||
The **job** of OpenPAI defines how to execute command(s) in specified environment(s). A job can be model training, or other kinds of commands, even it's distributed on multiple servers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
even can be
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
README.md
Outdated
@@ -109,41 +109,23 @@ If FAQ doesn't resolve it, refer to [here](#get-involved) to ask question or sub | |||
|
|||
## Train models | |||
|
|||
Like all machine learning platforms, OpenPAI is a production tool. To maximize utilization, it's recommended to submit training jobs and OpenPAI will allocate resource to run it. If there are too many jobs, some jobs may wait in the queue. This is different with training models on dedicated servers for each person, and it needs a bit more knowledge about how to submit/manage training jobs on OpenPAI. | |||
Like all machine learning platforms, OpenPAI is a production tool. To maximize utilization, it's recommended to submit training jobs and let OpenPAI to allocate resource and run it. If there are too many jobs, some jobs may wait in the queue, and OpenPAI choose some server(s) to run a job. This is different with run code on specified servers, and it needs a bit more knowledge about how to submit/manage training jobs on OpenPAI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a productivity tool
and run -> for running
queue, 后的一堆 -> queue till needed resources are allocated.
specified->dedicated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed part of them
* add a dashboard in grafana to list all tasks in node (#2197) * Fix format in issue templates (#2233) Fix format in issue templates: - remove trailing spaces - change chinese colon into english * Fix auto retries when out of memory. (#1108) * Distinguish cgroup OOM from dmesg. * Remove cgroup OOM detection Make all OOM cause exiting by 5 * Exit 55 when OOM * Refine homepage for new users (#2155) Updated first level bullets, to add more content for administrators and users, who is first time touch OpenPAI, or computing platform. * Fix yarn container failed when docker container exited quickly. (#2256) * REST server: remove expires in JWT payload of unit test (#2263) * Deploy: add explicit config field in webportal plugin (#2251) * Deploy: add explicit config field in webportal plugin * Fix json.dumps * t * fix * Update PLUGINS.md * Update webportal.md * alert on unhealthy gpu (#2209) * Pylon: fix double start query in yarn redirect (#2258) * Pylon: fix double start query in yarn redirect * Hide debug info in docker-compose.yaml * adapt user transfer script to new config (#2266) * Webportal: add pai-version attribute to <pai-plugin> (#2245) * Webportal: add pai-version attribute to <pai-plugin> * Use preprocess to apply window.PAI_VERSION * set version in layout.html * Fix ib drivers bug (#2269) * FIx ib installation script bug (#2271) * [BUG] Fix hadoop ai build path (#2262) * fix hadoop ai build bugs * refine * Web portal submit job: support init json from sessionStorage. (#2253) * YARN and HDFS log persistence (#2244) * rm log persist * change log dir to host * persist nm log to host * resolve conflict * persist namenode log * persist data node log * add comments * move log path to common pai storage * use twisted in yarn-exporter (#2273) * [Job Debugging] Basic Implement Of Job Debugging. (#2272) * Refine document for new user to submit job (#2278) 1. add new guidance to submit job for beginners. 2. refine homepage to connect with new guidance. 3. reorganize content of troubleshooting for next refactoring. 4. fix links in md files. * [Drivers] Fix the issue when installing IB drivers. (#2275) * fix can not report zombie process using gpu error (#2279) * fix external process error * add debug log * fix short ID and long ID do not match * use time based atomic ref to exchange info between threads * add test case for AtomicRef * fix bug in file remove (#2288) * fix hadoop build error (#2296) * export vc/node related metrics from yarn (#2289) * 720 * open hdfs explorer in view container enable tslint rule "ordered-imports" * add tslint rule for indent * add home button to hdfs explorer's navigation; adjust octicon's color * fix lint error * [VS Code] Add job list (#2160) * add job list view to pai extension * [VS Code] joblist fix (#2185) * eager load recent jobs when job submitted * avoid eager getChildren, and let vscode treeview.reveal do it implicitly * fix lint error
* add a dashboard in grafana to list all tasks in node (#2197) * Fix format in issue templates (#2233) Fix format in issue templates: - remove trailing spaces - change chinese colon into english * Fix auto retries when out of memory. (#1108) * Distinguish cgroup OOM from dmesg. * Remove cgroup OOM detection Make all OOM cause exiting by 5 * Exit 55 when OOM * Refine homepage for new users (#2155) Updated first level bullets, to add more content for administrators and users, who is first time touch OpenPAI, or computing platform. * Fix yarn container failed when docker container exited quickly. (#2256) * REST server: remove expires in JWT payload of unit test (#2263) * Deploy: add explicit config field in webportal plugin (#2251) * Deploy: add explicit config field in webportal plugin * Fix json.dumps * t * fix * Update PLUGINS.md * Update webportal.md * alert on unhealthy gpu (#2209) * Pylon: fix double start query in yarn redirect (#2258) * Pylon: fix double start query in yarn redirect * Hide debug info in docker-compose.yaml * adapt user transfer script to new config (#2266) * Webportal: add pai-version attribute to <pai-plugin> (#2245) * Webportal: add pai-version attribute to <pai-plugin> * Use preprocess to apply window.PAI_VERSION * set version in layout.html * Fix ib drivers bug (#2269) * FIx ib installation script bug (#2271) * [BUG] Fix hadoop ai build path (#2262) * fix hadoop ai build bugs * refine * Web portal submit job: support init json from sessionStorage. (#2253) * YARN and HDFS log persistence (#2244) * rm log persist * change log dir to host * persist nm log to host * resolve conflict * persist namenode log * persist data node log * add comments * move log path to common pai storage * use twisted in yarn-exporter (#2273) * [Job Debugging] Basic Implement Of Job Debugging. (#2272) * Refine document for new user to submit job (#2278) 1. add new guidance to submit job for beginners. 2. refine homepage to connect with new guidance. 3. reorganize content of troubleshooting for next refactoring. 4. fix links in md files. * [Drivers] Fix the issue when installing IB drivers. (#2275) * fix can not report zombie process using gpu error (#2279) * fix external process error * add debug log * fix short ID and long ID do not match * use time based atomic ref to exchange info between threads * add test case for AtomicRef * fix bug in file remove (#2288) * fix hadoop build error (#2296) * export vc/node related metrics from yarn (#2289) * 720 * open hdfs explorer in view container enable tslint rule "ordered-imports" * add tslint rule for indent * add home button to hdfs explorer's navigation; adjust octicon's color * fix lint error * [VS Code] Add job list (#2160) * add job list view to pai extension * [VS Code] joblist fix (#2185) * eager load recent jobs when job submitted * avoid eager getChildren, and let vscode treeview.reveal do it implicitly * fix lint error
* add installation guide for VS code extension (#2223) * add installation guide for VS code extension * [VS Code] view container (#2301) * add a dashboard in grafana to list all tasks in node (#2197) * Fix format in issue templates (#2233) Fix format in issue templates: - remove trailing spaces - change chinese colon into english * Fix auto retries when out of memory. (#1108) * Distinguish cgroup OOM from dmesg. * Remove cgroup OOM detection Make all OOM cause exiting by 5 * Exit 55 when OOM * Refine homepage for new users (#2155) Updated first level bullets, to add more content for administrators and users, who is first time touch OpenPAI, or computing platform. * Fix yarn container failed when docker container exited quickly. (#2256) * REST server: remove expires in JWT payload of unit test (#2263) * Deploy: add explicit config field in webportal plugin (#2251) * Deploy: add explicit config field in webportal plugin * Fix json.dumps * t * fix * Update PLUGINS.md * Update webportal.md * alert on unhealthy gpu (#2209) * Pylon: fix double start query in yarn redirect (#2258) * Pylon: fix double start query in yarn redirect * Hide debug info in docker-compose.yaml * adapt user transfer script to new config (#2266) * Webportal: add pai-version attribute to <pai-plugin> (#2245) * Webportal: add pai-version attribute to <pai-plugin> * Use preprocess to apply window.PAI_VERSION * set version in layout.html * Fix ib drivers bug (#2269) * FIx ib installation script bug (#2271) * [BUG] Fix hadoop ai build path (#2262) * fix hadoop ai build bugs * refine * Web portal submit job: support init json from sessionStorage. (#2253) * YARN and HDFS log persistence (#2244) * rm log persist * change log dir to host * persist nm log to host * resolve conflict * persist namenode log * persist data node log * add comments * move log path to common pai storage * use twisted in yarn-exporter (#2273) * [Job Debugging] Basic Implement Of Job Debugging. (#2272) * Refine document for new user to submit job (#2278) 1. add new guidance to submit job for beginners. 2. refine homepage to connect with new guidance. 3. reorganize content of troubleshooting for next refactoring. 4. fix links in md files. * [Drivers] Fix the issue when installing IB drivers. (#2275) * fix can not report zombie process using gpu error (#2279) * fix external process error * add debug log * fix short ID and long ID do not match * use time based atomic ref to exchange info between threads * add test case for AtomicRef * fix bug in file remove (#2288) * fix hadoop build error (#2296) * export vc/node related metrics from yarn (#2289) * 720 * open hdfs explorer in view container enable tslint rule "ordered-imports" * add tslint rule for indent * add home button to hdfs explorer's navigation; adjust octicon's color * fix lint error * [VS Code] Add job list (#2160) * add job list view to pai extension * [VS Code] joblist fix (#2185) * eager load recent jobs when job submitted * avoid eager getChildren, and let vscode treeview.reveal do it implicitly * fix lint error * [VS Code] default to generate jsonc job config file (#2368) * 720 * open hdfs explorer in view container enable tslint rule "ordered-imports" * add tslint rule for indent * add home button to hdfs explorer's navigation; adjust octicon's color * fix lint error * [VS Code] Add job list (#2160) * add job list view to pai extension * [VS Code] joblist fix (#2185) * eager load recent jobs when job submitted * avoid eager getChildren, and let vscode treeview.reveal do it implicitly * default to generate jsonc job config file * [VS Code] Refine error messages; Fix Cluster Explorer's bug * [VS Code] changelog and readme (#2429) * 539 * 712 * 452 * [VS Code] v0.11 compatible issue (#2457) * 536 * 600 * [VS Code] fix cluster explorer's right-click menu (#2463)