Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

Commit

Permalink
[Doc] update job tutorial doc about minFailedTaskCount and minSucceed…
Browse files Browse the repository at this point in the history
…edTaskCount (#2009)

* update job tutorial doc

* fix comment

* fix comment

* fix min succeed task count
  • Loading branch information
wangcan0329 authored Jan 15, 2019
1 parent 4372019 commit 266aee6
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/job_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ Below please find the detailed explanation for each of the parameters in the con
| `taskRole.portType.beginAt` | Integer, required | The port to begin with in the port type, 0 for random selection |
| `taskRole.portType.portNumber` | Integer, required | Number of ports for the specific type |
| `taskRole.command` | String, required | Executable command for tasks in the task role, can not be empty |
| `taskRole.minFailedTaskCount` | Integer, optional | Number of failed tasks to kill the entire job, null or no less than 1, refer to [frameworklauncher usermanual](../subprojects/frameworklauncher/yarn/doc/USERMANUAL.md#ApplicationCompletionPolicy) for details |
| `taskRole.minSucceededTaskCount` | Integer, optional | Number of succeeded tasks to kill the entire job, null or no less than 1, refer to [frameworklauncher usermanual](../subprojects/frameworklauncher/yarn/doc/USERMANUAL.md#ApplicationCompletionPolicy) for details |
| `taskRole.minFailedTaskCount` | Integer, optional | Number of failed tasks to fail the entire job, null or no less than 1, if set to null means the job will always succeed regardless any task failure. Please refer to [frameworklauncher usermanual](../subprojects/frameworklauncher/yarn/doc/USERMANUAL.md#ApplicationCompletionPolicy) for details |
| `taskRole.minSucceededTaskCount` | Integer, optional | Number of succeeded tasks to succeed the entire job, null or no less than 1, if set to null means the job will only succeed until all tasks are completed and minFailedTaskCount is not triggered. Please refer to [frameworklauncher usermanual](../subprojects/frameworklauncher/yarn/doc/USERMANUAL.md#ApplicationCompletionPolicy) for details |
| `gpuType` | String, optional | Specify the GPU type to be used in the tasks. If omitted, the job will run on any gpu type |
| `retryCount` | Integer, optional | Job retry count, no less than 0 |
| `jobEnvs` | Object, optional | Job env parameters, key-value pairs, available in job container and **no substitution allowed** |
Expand Down

0 comments on commit 266aee6

Please sign in to comment.