Skip to content

Commit 73a41b3

Browse files
authored
Update description for scheduler type (#222)
* Update description for scheduler type Tested in terminal with command `hyp create hyp-pytorch-job --help` and can see new description * Update scheduler type description in v1_0
1 parent 21d7ca2 commit 73a41b3

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

doc/cli_training.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ hyp create hyp-pytorch-job [OPTIONS]
4040
- `--tasks-per-node INTEGER`: Number of tasks per node (minimum: 1)
4141
- `--label-selector OBJECT`: Node label selector as key-value pairs
4242
- `--deep-health-check-passed-nodes-only BOOLEAN`: Schedule pods only on nodes that passed deep health check (default: false)
43-
- `--scheduler-type TEXT`: Scheduler type
43+
- `--scheduler-type TEXT`: If specified, training job pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
4444
- `--queue-name TEXT`: Queue name for job scheduling (1-63 characters, alphanumeric with hyphens)
4545
- `--priority TEXT`: Priority class for job scheduling
4646
- `--max-retry INTEGER`: Maximum number of job retries (minimum: 0)

hyperpod-pytorch-job-template/hyperpod_pytorch_job_template/v1_0/model.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ class PyTorchJobConfig(BaseModel):
125125
scheduler_type: Optional[str] = Field(
126126
default=None,
127127
alias="scheduler_type",
128-
description="Scheduler type",
128+
description="If specified, training job pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.",
129129
min_length=1
130130
)
131131
queue_name: Optional[str] = Field(

hyperpod-pytorch-job-template/hyperpod_pytorch_job_template/v1_0/schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@
252252
}
253253
],
254254
"default": null,
255-
"description": "Scheduler type",
255+
"description": "If specified, training job pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.",
256256
"title": "Scheduler Type"
257257
},
258258
"queue_name": {

hyperpod-pytorch-job-template/hyperpod_pytorch_job_template/v1_1/model.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ class PyTorchJobConfig(BaseModel):
133133
scheduler_type: Optional[str] = Field(
134134
default=None,
135135
alias="scheduler_type",
136-
description="Scheduler type",
136+
description="If specified, training job pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.",
137137
min_length=1
138138
)
139139
queue_name: Optional[str] = Field(

hyperpod-pytorch-job-template/hyperpod_pytorch_job_template/v1_1/schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@
260260
}
261261
],
262262
"default": null,
263-
"description": "Scheduler type",
263+
"description": "If specified, training job pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.",
264264
"title": "Scheduler Type"
265265
},
266266
"queue_name": {

0 commit comments

Comments
 (0)