Skip to content

Commit 20fc45d

Browse files
SteVwonderSteVwonder
committed
rfc14,25,31: 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 8680493 commit 20fc45d

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
@@ -409,7 +409,8 @@ requests are similar to existing resource manager batch job submission or
409409
allocation requests, i.e. equivalent to ``oarsub``, ``qsub``, and ``salloc``.
410410

411411
Use Case 1.1
412-
Request Single Resource with Count
412+
^^^^^^^^^^^^
413+
Request Single Resource with Count
413414

414415
Specific Example
415416
Request 4 nodes
@@ -426,7 +427,8 @@ Jobspec YAML
426427
:language: yaml
427428

428429
Use Case 1.2
429-
Request a range of a type of resource
430+
^^^^^^^^^^^^
431+
Request a range of a type of resource
430432

431433
Specific Example
432434
Request between 3 and 30 nodes
@@ -441,7 +443,8 @@ Jobspec YAML
441443
:language: yaml
442444

443445
Use Case 1.3
444-
Request M nodes with a minimum number of sockets per node
446+
^^^^^^^^^^^^
447+
Request M nodes with a minimum number of sockets per node
445448
and cores per socket
446449

447450
Specific Example
@@ -462,7 +465,8 @@ Jobspec YAML
462465
:language: yaml
463466

464467
Use Case 1.4
465-
Exclusively allocate nodes, while constraining cores and
468+
^^^^^^^^^^^^
469+
Exclusively allocate nodes, while constraining cores and
466470
sockets.
467471

468472
Specific Example
@@ -474,7 +478,8 @@ Jobspec YAML
474478
:language: yaml
475479

476480
Use Case 1.5
477-
Complex example from OAR
481+
^^^^^^^^^^^^
482+
Complex example from OAR
478483

479484
Specific Example
480485
ask for 1 core on 2 nodes on the same cluster with 4096 GB of memory
@@ -494,7 +499,8 @@ Jobspec YAML
494499
:language: yaml
495500

496501
Use Case 1.6
497-
Request resources across multiple clusters
502+
^^^^^^^^^^^^
503+
Request resources across multiple clusters
498504

499505
Specific Example
500506
Ask for 30 cores on 2 clusters (total = 60 cores), with 1 flux broker launched per node
@@ -504,7 +510,8 @@ Jobspec YAML
504510
:language: yaml
505511

506512
Use Case 1.7
507-
Request N cores across M switches
513+
^^^^^^^^^^^^
514+
Request N cores across M switches
508515

509516
Specific Example
510517
Request 3 cores across 3 switches, with 1 flux broker launched per node
@@ -525,7 +532,8 @@ The following use cases are more general and include more complex slot placement
525532
and task counts.
526533

527534
Use Case 2.1
528-
Run N tasks across M nodes
535+
^^^^^^^^^^^^
536+
Run N tasks across M nodes
529537

530538
Specific Example
531539
Run ``hostname`` 20 times on 4 nodes, 5 per node
@@ -543,7 +551,8 @@ Jobspec YAML
543551
:language: yaml
544552

545553
Use Case 2.2
546-
Run N tasks across M nodes, unequal distribution
554+
^^^^^^^^^^^^
555+
Run N tasks across M nodes, unequal distribution
547556

548557
Specific Example
549558
Run 5 copies of ``hostname`` across 4 nodes,
@@ -559,7 +568,8 @@ Jobspec YAML
559568
:language: yaml
560569

561570
Use Case 2.3
562-
Run N tasks, Require M cores per task
571+
^^^^^^^^^^^^
572+
Run N tasks, Require M cores per task
563573

564574
Specific Example
565575
Run 10 copies of ``myapp``, require 2 cores per copy,
@@ -575,7 +585,8 @@ Jobspec YAML
575585
:language: yaml
576586

577587
Use Case 2.4
578-
Run different binaries with differing resource
588+
^^^^^^^^^^^^
589+
Run different binaries with differing resource
579590
requirements as single program
580591

581592
Specific Example
@@ -590,7 +601,8 @@ Jobspec YAML
590601
:language: yaml
591602

592603
Use Case 2.5
593-
Run command requesting minimum amount of RAM per core
604+
^^^^^^^^^^^^
605+
Run command requesting minimum amount of RAM per core
594606

595607
Specific Example
596608
Run 10 copies of ``app`` across 10 cores with at least 2GB per core
@@ -605,7 +617,8 @@ Jobspec YAML
605617
:language: yaml
606618

607619
Use Case 2.6
608-
Run N copies of a command with minimum amount of RAM per node
620+
^^^^^^^^^^^^
621+
Run N copies of a command with minimum amount of RAM per node
609622

610623
Specific Example
611624
Run 10 copies of ``app`` across 2 nodes with at least 4GB per node
@@ -622,7 +635,8 @@ Jobspec YAML
622635
:language: yaml
623636

624637
Use Case 2.7
625-
Override the global environment
638+
^^^^^^^^^^^^
639+
Override the global environment
626640

627641
Specific Example
628642
Run two different tasks, one with the global environment and one with an
@@ -633,7 +647,8 @@ Jobspec YAML
633647
:language: yaml
634648

635649
Use Case 2.8
636-
Specify dependencies
650+
^^^^^^^^^^^^
651+
Specify dependencies
637652

638653
Specific Example
639654
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
@@ -201,7 +201,8 @@ requests are similar to existing resource manager batch job submission or
201201
allocation requests, i.e. equivalent to ``oarsub``, ``qsub``, and ``salloc``.
202202

203203
Use Case 1.1
204-
Request nodes outside of a slot
204+
^^^^^^^^^^^^
205+
Request nodes outside of a slot
205206

206207
Specific Example
207208
Request 4 nodes, each with 1 slot
@@ -225,7 +226,8 @@ The following use cases are more general and include more complex slot placement
225226
and task counts.
226227

227228
Use Case 2.1
228-
Run N tasks across M nodes, unequal distribution
229+
^^^^^^^^^^^^
230+
Run N tasks across M nodes, unequal distribution
229231

230232
Specific Example
231233
Run 5 copies of ``hostname`` across 4 nodes,
@@ -241,7 +243,8 @@ Jobspec YAML
241243
:language: yaml
242244

243245
Use Case 2.2
244-
Run N tasks, Require M cores per task
246+
^^^^^^^^^^^^
247+
Run N tasks, Require M cores per task
245248

246249
Specific Example
247250
Run 10 copies of ``myapp``, require 2 cores per copy,
@@ -257,7 +260,8 @@ Jobspec YAML
257260
:language: yaml
258261

259262
Use Case 2.3
260-
Run N tasks, Require M cores and J gpus per task
263+
^^^^^^^^^^^^
264+
Run N tasks, Require M cores and J gpus per task
261265

262266
Specific Example
263267
Run 10 copies of ``myapp``, require 2 cores and 1 gpu per copy,
@@ -268,7 +272,8 @@ Jobspec YAML
268272
:language: yaml
269273

270274
Use Case 2.4
271-
Run N tasks across M nodes, each task with 1 core and 1 gpu
275+
^^^^^^^^^^^^
276+
Run N tasks across M nodes, each task with 1 core and 1 gpu
272277

273278
Specific Example
274279
Run 16 copies of ``myapp`` across 4 nodes, each copy with

‎spec_31.rst‎

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

81-
8281
Resources
8382
~~~~~~~~~
8483

@@ -214,7 +213,8 @@ requests are similar to existing resource manager batch job submission or
214213
allocation requests, i.e. equivalent to ``oarsub``, ``qsub``, and ``salloc``.
215214

216215
Use Case 1.1
217-
Request nodes outside of a slot
216+
^^^^^^^^^^^^
217+
Request nodes outside of a slot
218218

219219
Specific Example
220220
Request 4 nodes, each with 1 slot
@@ -232,7 +232,8 @@ Jobspec YAML
232232

233233

234234
Use Case 1.2
235-
Request nodes inside of a slot
235+
^^^^^^^^^^^^
236+
Request nodes inside of a slot
236237

237238
Specific Example
238239
Request 4 slots, each with 1 node
@@ -250,7 +251,8 @@ Jobspec YAML
250251

251252

252253
Use Case 1.3
253-
Request a fixed number of cores with no constraint on nodes
254+
^^^^^^^^^^^^
255+
Request a fixed number of cores with no constraint on nodes
254256

255257
Specific Example
256258
Request 120 cores, one broker per node
@@ -268,7 +270,8 @@ and task counts.
268270

269271

270272
Use Case 2.1
271-
Run N tasks across M nodes, unequal distribution
273+
^^^^^^^^^^^^
274+
Run N tasks across M nodes, unequal distribution
272275

273276
Specific Example
274277
Run 5 copies of ``hostname`` across 4 nodes,
@@ -283,8 +286,9 @@ Jobspec YAML
283286
.. literalinclude:: data/spec_31/use_case_2.1.yaml
284287
:language: yaml
285288

286-
Use Case 2.2
287-
Run N tasks, Require M cores per task
289+
Use Case 2.3
290+
^^^^^^^^^^^^
291+
Run N tasks, Require M cores per task
288292

289293
Specific Example
290294
Run 10 copies of ``myapp``, require 2 cores per copy,
@@ -299,8 +303,9 @@ Jobspec YAML
299303
.. literalinclude:: data/spec_31/use_case_2.2.yaml
300304
:language: yaml
301305

302-
Use Case 2.3
303-
Run N tasks, Require M cores and J gpus per task
306+
Use Case 2.4
307+
^^^^^^^^^^^^
308+
Run N tasks, Require M cores and J gpus per task
304309

305310
Specific Example
306311
Run 10 copies of ``myapp``, require 2 cores and 1 gpu per copy,
@@ -310,8 +315,9 @@ Jobspec YAML
310315
.. literalinclude:: data/spec_31/use_case_2.3.yaml
311316
:language: yaml
312317

313-
Use Case 2.4
314-
Run N tasks across M nodes, each task with 1 core and 1 gpu
318+
Use Case 2.5
319+
^^^^^^^^^^^^
320+
Run N tasks across M nodes, each task with 1 core and 1 gpu
315321

316322
Specific Example
317323
Run 16 copies of ``myapp`` across 4 nodes, each copy with
@@ -326,8 +332,9 @@ Jobspec YAML
326332
.. literalinclude:: data/spec_31/use_case_2.4.yaml
327333
:language: yaml
328334

329-
Use Case 2.5
330-
Specify dependencies
335+
Use Case 2.6
336+
^^^^^^^^^^^^
337+
Specify dependencies
331338

332339
Specific Example
333340
Depend on two previously submitted jobs. The first job’s

0 commit comments

Comments
 (0)