Skip to content

Commit d405d72

Browse files
SteVwonderSteVwonder
committed
rfc14,25,27: switch use-case X.Y headers to rst titles
improves the separation between use-cases by making the use-case headers distinct from the headers for "existing examples" and "jobspec YAML"
1 parent b2303f3 commit d405d72

File tree

3 files changed

+60
-33
lines changed

3 files changed

+60
-33
lines changed

‎spec_14.rst‎

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,8 @@ requests are similar to existing resource manager batch job submission or
406406
allocation requests, i.e. equivalent to ``oarsub``, ``qsub``, and ``salloc``.
407407

408408
Use Case 1.1
409-
Request Single Resource with Count
409+
^^^^^^^^^^^^
410+
Request Single Resource with Count
410411

411412
Specific Example
412413
Request 4 nodes
@@ -423,7 +424,8 @@ Jobspec YAML
423424
:language: yaml
424425

425426
Use Case 1.2
426-
Request a range of a type of resource
427+
^^^^^^^^^^^^
428+
Request a range of a type of resource
427429

428430
Specific Example
429431
Request between 3 and 30 nodes
@@ -438,7 +440,8 @@ Jobspec YAML
438440
:language: yaml
439441

440442
Use Case 1.3
441-
Request M nodes with a minimum number of sockets per node
443+
^^^^^^^^^^^^
444+
Request M nodes with a minimum number of sockets per node
442445
and cores per socket
443446

444447
Specific Example
@@ -459,7 +462,8 @@ Jobspec YAML
459462
:language: yaml
460463

461464
Use Case 1.4
462-
Exclusively allocate nodes, while constraining cores and
465+
^^^^^^^^^^^^
466+
Exclusively allocate nodes, while constraining cores and
463467
sockets.
464468

465469
Specific Example
@@ -471,7 +475,8 @@ Jobspec YAML
471475
:language: yaml
472476

473477
Use Case 1.5
474-
Complex example from OAR
478+
^^^^^^^^^^^^
479+
Complex example from OAR
475480

476481
Specific Example
477482
ask for 1 core on 2 nodes on the same cluster with 4096 GB of memory
@@ -491,7 +496,8 @@ Jobspec YAML
491496
:language: yaml
492497

493498
Use Case 1.6
494-
Request resources across multiple clusters
499+
^^^^^^^^^^^^
500+
Request resources across multiple clusters
495501

496502
Specific Example
497503
Ask for 30 cores on 2 clusters (total = 60 cores), with 1 flux broker launched per node
@@ -501,7 +507,8 @@ Jobspec YAML
501507
:language: yaml
502508

503509
Use Case 1.7
504-
Request N cores across M switches
510+
^^^^^^^^^^^^
511+
Request N cores across M switches
505512

506513
Specific Example
507514
Request 3 cores across 3 switches, with 1 flux broker launched per node
@@ -522,7 +529,8 @@ The following use cases are more general and include more complex slot placement
522529
and task counts.
523530

524531
Use Case 2.1
525-
Run N tasks across M nodes
532+
^^^^^^^^^^^^
533+
Run N tasks across M nodes
526534

527535
Specific Example
528536
Run ``hostname`` 20 times on 4 nodes, 5 per node
@@ -540,7 +548,8 @@ Jobspec YAML
540548
:language: yaml
541549

542550
Use Case 2.2
543-
Run N tasks across M nodes, unequal distribution
551+
^^^^^^^^^^^^
552+
Run N tasks across M nodes, unequal distribution
544553

545554
Specific Example
546555
Run 5 copies of ``hostname`` across 4 nodes,
@@ -556,7 +565,8 @@ Jobspec YAML
556565
:language: yaml
557566

558567
Use Case 2.3
559-
Run N tasks, Require M cores per task
568+
^^^^^^^^^^^^
569+
Run N tasks, Require M cores per task
560570

561571
Specific Example
562572
Run 10 copies of ``myapp``, require 2 cores per copy,
@@ -572,7 +582,8 @@ Jobspec YAML
572582
:language: yaml
573583

574584
Use Case 2.4
575-
Run different binaries with differing resource
585+
^^^^^^^^^^^^
586+
Run different binaries with differing resource
576587
requirements as single program
577588

578589
Specific Example
@@ -587,7 +598,8 @@ Jobspec YAML
587598
:language: yaml
588599

589600
Use Case 2.5
590-
Run command requesting minimum amount of RAM per core
601+
^^^^^^^^^^^^
602+
Run command requesting minimum amount of RAM per core
591603

592604
Specific Example
593605
Run 10 copies of ``app`` across 10 cores with at least 2GB per core
@@ -602,7 +614,8 @@ Jobspec YAML
602614
:language: yaml
603615

604616
Use Case 2.6
605-
Run N copies of a command with minimum amount of RAM per node
617+
^^^^^^^^^^^^
618+
Run N copies of a command with minimum amount of RAM per node
606619

607620
Specific Example
608621
Run 10 copies of ``app`` across 2 nodes with at least 4GB per node
@@ -619,7 +632,8 @@ Jobspec YAML
619632
:language: yaml
620633

621634
Use Case 2.7
622-
Override the global environment
635+
^^^^^^^^^^^^
636+
Override the global environment
623637

624638
Specific Example
625639
Run two different tasks, one with the global environment and one with an
@@ -630,7 +644,8 @@ Jobspec YAML
630644
:language: yaml
631645

632646
Use Case 2.8
633-
Specify dependencies
647+
^^^^^^^^^^^^
648+
Specify dependencies
634649

635650
Specific Example
636651
Depend on two previously submitted jobs. The first job’s

‎spec_25.rst‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,8 @@ requests are similar to existing resource manager batch job submission or
198198
allocation requests, i.e. equivalent to ``oarsub``, ``qsub``, and ``salloc``.
199199

200200
Use Case 1.1
201-
Request nodes outside of a slot
201+
^^^^^^^^^^^^
202+
Request nodes outside of a slot
202203

203204
Specific Example
204205
Request 4 nodes, each with 1 slot
@@ -222,7 +223,8 @@ The following use cases are more general and include more complex slot placement
222223
and task counts.
223224

224225
Use Case 2.1
225-
Run N tasks across M nodes, unequal distribution
226+
^^^^^^^^^^^^
227+
Run N tasks across M nodes, unequal distribution
226228

227229
Specific Example
228230
Run 5 copies of ``hostname`` across 4 nodes,
@@ -238,7 +240,8 @@ Jobspec YAML
238240
:language: yaml
239241

240242
Use Case 2.2
241-
Run N tasks, Require M cores per task
243+
^^^^^^^^^^^^
244+
Run N tasks, Require M cores per task
242245

243246
Specific Example
244247
Run 10 copies of ``myapp``, require 2 cores per copy,
@@ -254,7 +257,8 @@ Jobspec YAML
254257
:language: yaml
255258

256259
Use Case 2.3
257-
Run N tasks, Require M cores and J gpus per task
260+
^^^^^^^^^^^^
261+
Run N tasks, Require M cores and J gpus per task
258262

259263
Specific Example
260264
Run 10 copies of ``myapp``, require 2 cores and 1 gpu per copy,
@@ -265,7 +269,8 @@ Jobspec YAML
265269
:language: yaml
266270

267271
Use Case 2.4
268-
Run N tasks across M nodes, each task with 1 core and 1 gpu
272+
^^^^^^^^^^^^
273+
Run N tasks across M nodes, each task with 1 core and 1 gpu
269274

270275
Specific Example
271276
Run 16 copies of ``myapp`` across 4 nodes, each copy with

‎spec_27.rst‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ Each of the listed jobspec keys SHALL meet the form and requirements
8282
listed in detail in the sections below. For reference, a ruleset for
8383
compliant jobspec V2 is provided in the **Schema** section below.
8484

85-
8685
Resources
8786
~~~~~~~~~
8887

@@ -240,7 +239,8 @@ requests are similar to existing resource manager batch job submission or
240239
allocation requests, i.e. equivalent to ``oarsub``, ``qsub``, and ``salloc``.
241240

242241
Use Case 1.1
243-
Request nodes outside of a slot
242+
^^^^^^^^^^^^
243+
Request nodes outside of a slot
244244

245245
Specific Example
246246
Request 4 nodes, each with 1 slot
@@ -258,7 +258,8 @@ Jobspec YAML
258258

259259

260260
Use Case 1.2
261-
Request nodes inside of a slot
261+
^^^^^^^^^^^^
262+
Request nodes inside of a slot
262263

263264
Specific Example
264265
Request 4 slots, each with 1 node
@@ -276,7 +277,8 @@ Jobspec YAML
276277

277278

278279
Use Case 1.3
279-
Request a fixed number of cores with no constraint on nodes
280+
^^^^^^^^^^^^
281+
Request a fixed number of cores with no constraint on nodes
280282

281283
Specific Example
282284
Request 120 cores, one broker per node
@@ -299,7 +301,8 @@ and task counts.
299301

300302

301303
Use Case 2.1
302-
Run N tasks across M nodes, unequal distribution
304+
^^^^^^^^^^^^
305+
Run N tasks across M nodes, unequal distribution
303306

304307
Specific Example
305308
Run 5 copies of ``hostname`` across 4 nodes,
@@ -314,8 +317,9 @@ Jobspec YAML
314317
.. literalinclude:: data/spec_27/use_case_2.1.yaml
315318
:language: yaml
316319

317-
Use Case 2.2
318-
Run N tasks, Require M cores per task
320+
Use Case 2.3
321+
^^^^^^^^^^^^
322+
Run N tasks, Require M cores per task
319323

320324
Specific Example
321325
Run 10 copies of ``myapp``, require 2 cores per copy,
@@ -330,8 +334,9 @@ Jobspec YAML
330334
.. literalinclude:: data/spec_27/use_case_2.2.yaml
331335
:language: yaml
332336

333-
Use Case 2.3
334-
Run N tasks, Require M cores and J gpus per task
337+
Use Case 2.4
338+
^^^^^^^^^^^^
339+
Run N tasks, Require M cores and J gpus per task
335340

336341
Specific Example
337342
Run 10 copies of ``myapp``, require 2 cores and 1 gpu per copy,
@@ -341,8 +346,9 @@ Jobspec YAML
341346
.. literalinclude:: data/spec_27/use_case_2.3.yaml
342347
:language: yaml
343348

344-
Use Case 2.4
345-
Run N tasks across M nodes, each task with 1 core and 1 gpu
349+
Use Case 2.5
350+
^^^^^^^^^^^^
351+
Run N tasks across M nodes, each task with 1 core and 1 gpu
346352

347353
Specific Example
348354
Run 16 copies of ``myapp`` across 4 nodes, each copy with
@@ -357,8 +363,9 @@ Jobspec YAML
357363
.. literalinclude:: data/spec_27/use_case_2.4.yaml
358364
:language: yaml
359365

360-
Use Case 2.5
361-
Specify dependencies
366+
Use Case 2.6
367+
^^^^^^^^^^^^
368+
Specify dependencies
362369

363370
Specific Example
364371
Depend on two previously submitted jobs. The first job’s

0 commit comments

Comments
 (0)