Skip to content

Commit

Permalink
Merge pull request #1335 from run-ai/RUN-24893-TW-CLI-Support-CleanPo…
Browse files Browse the repository at this point in the history
…dPolicy-flag-in-CLIv2

Update policy-reference.md
  • Loading branch information
SherinDaher-Runai authored Jan 2, 2025
2 parents e39670a + 559ba10 commit 11b0d9e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/platform-admin/workloads/policies/policy-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Click the link to view the value type of each field.
| terminateAfterPreemtpion | Indicates whether the job should be terminated, by the system, after it has been preempted | boolean | Workspace Training |
| autoDeletionTimeAfterCompletionSeconds | Specifies the duration after which a finished workload (Completed or Failed) is automatically deleted. If this field is set to zero, the workload becomes eligible to be deleted immediately after it finishes. | integer | Workspace Training |
| backoffLimit | Specifies the number of retries before marking a workload as failed | integer | Workspace Training |
| cleanPodPolicy | <p>Specifies which pods will be deleted when the workload reaches a terminal state (completed/failed). The policy can be one of the following values:</p><ul><li>`Running` - only pods still running when a job completes (for example, parameter servers) will be deleted immediately. Completed pods will not be deleted so that the logs will be preserved. (Default).</li><li>`All` - all (including completed) pods will be deleted immediately when the job finishes.</li><li>`None` - no pods will be deleted when the job completes.</li></ul> | string | Distributed |
| cleanPodPolicy | <p>Specifies which pods will be deleted when the workload reaches a terminal state (completed/failed). The policy can be one of the following values:</p><ul><li>`Running` - Only pods still running when a job completes (for example, parameter servers) will be deleted immediately. Completed pods will not be deleted so that the logs will be preserved. (Default).</li><li>`All` - All (including completed) pods will be deleted immediately when the job finishes.</li><li>`None` - No pods will be deleted when the job completes. It will keep running pods that consume GPU, CPU and memory over time. It is recommended to set to None only for debugging and obtaining logs from running pods.</li></ul> | string | Distributed |
| completions | Used with Hyperparameter Optimization. Specifies the number of successful pods the job should reach to be completed. The Job is marked as successful once the specified amount of pods has succeeded. | integer | Workspace Training |
| parallelism | Used with Hyperparameters Optimization. Specifies the maximum desired number of pods the workload should run at any given time. | itemized | Workspace Training |
| exposeUrls | Specifies a set of exported URL (e.g. ingress) from the container running the created workload. | itemized | Workspace Training |
Expand Down

0 comments on commit 11b0d9e

Please sign in to comment.