Skip to content

Commit

Permalink
rfc14,25,31: switch use-case X.Y headers to rst titles
Browse files Browse the repository at this point in the history 
improves the separation between use-cases by making the use-case headers
distinct from the headers for "existing examples" and "jobspec YAML"
  • Loading branch information
@SteVwonder
SteVwonder committed Feb 23, 2021
1 parent 4ad973b commit 528e150
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 33 deletions.
45 changes: 30 additions & 15 deletions spec_14.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,8 @@ requests are similar to existing resource manager batch job submission or
allocation requests, i.e. equivalent to ``oarsub``, ``qsub``, and ``salloc``.

Use Case 1.1
Request Single Resource with Count
^^^^^^^^^^^^
Request Single Resource with Count

Specific Example
Request 4 nodes
Expand All @@ -426,7 +427,8 @@ Jobspec YAML
:language: yaml

Use Case 1.2
Request a range of a type of resource
^^^^^^^^^^^^
Request a range of a type of resource

Specific Example
Request between 3 and 30 nodes
Expand All @@ -441,7 +443,8 @@ Jobspec YAML
:language: yaml

Use Case 1.3
Request M nodes with a minimum number of sockets per node
^^^^^^^^^^^^
Request M nodes with a minimum number of sockets per node
and cores per socket

Specific Example
Expand All @@ -462,7 +465,8 @@ Jobspec YAML
:language: yaml

Use Case 1.4
Exclusively allocate nodes, while constraining cores and
^^^^^^^^^^^^
Exclusively allocate nodes, while constraining cores and
sockets.

Specific Example
Expand All @@ -474,7 +478,8 @@ Jobspec YAML
:language: yaml

Use Case 1.5
Complex example from OAR
^^^^^^^^^^^^
Complex example from OAR

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

Use Case 1.6
Request resources across multiple clusters
^^^^^^^^^^^^
Request resources across multiple clusters

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

Use Case 1.7
Request N cores across M switches
^^^^^^^^^^^^
Request N cores across M switches

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

Use Case 2.1
Run N tasks across M nodes
^^^^^^^^^^^^
Run N tasks across M nodes

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

Use Case 2.2
Run N tasks across M nodes, unequal distribution
^^^^^^^^^^^^
Run N tasks across M nodes, unequal distribution

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

Use Case 2.3
Run N tasks, Require M cores per task
^^^^^^^^^^^^
Run N tasks, Require M cores per task

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

Use Case 2.4
Run different binaries with differing resource
^^^^^^^^^^^^
Run different binaries with differing resource
requirements as single program

Specific Example
Expand All @@ -590,7 +601,8 @@ Jobspec YAML
:language: yaml

Use Case 2.5
Run command requesting minimum amount of RAM per core
^^^^^^^^^^^^
Run command requesting minimum amount of RAM per core

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

Use Case 2.6
Run N copies of a command with minimum amount of RAM per node
^^^^^^^^^^^^
Run N copies of a command with minimum amount of RAM per node

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

Use Case 2.7
Override the global environment
^^^^^^^^^^^^
Override the global environment

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

Use Case 2.8
Specify dependencies
^^^^^^^^^^^^
Specify dependencies

Specific Example
Depend on two previously submitted jobs. The first job’s
Expand Down
15 changes: 10 additions & 5 deletions spec_25.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,8 @@ requests are similar to existing resource manager batch job submission or
allocation requests, i.e. equivalent to ``oarsub``, ``qsub``, and ``salloc``.

Use Case 1.1
Request nodes outside of a slot
^^^^^^^^^^^^
Request nodes outside of a slot

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

Use Case 2.1
Run N tasks across M nodes, unequal distribution
^^^^^^^^^^^^
Run N tasks across M nodes, unequal distribution

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

Use Case 2.2
Run N tasks, Require M cores per task
^^^^^^^^^^^^
Run N tasks, Require M cores per task

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

Use Case 2.3
Run N tasks, Require M cores and J gpus per task
^^^^^^^^^^^^
Run N tasks, Require M cores and J gpus per task

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

Use Case 2.4
Run N tasks across M nodes, each task with 1 core and 1 gpu
^^^^^^^^^^^^
Run N tasks across M nodes, each task with 1 core and 1 gpu

Specific Example
Run 16 copies of ``myapp`` across 4 nodes, each copy with
Expand Down
33 changes: 20 additions & 13 deletions spec_31.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ Each of the listed jobspec keys SHALL meet the form and requirements
listed in detail in the sections below. For reference, a ruleset for
compliant jobspec V2 is provided in the **Schema** section below.


Resources
~~~~~~~~~

Expand Down Expand Up @@ -218,7 +217,8 @@ requests are similar to existing resource manager batch job submission or
allocation requests, i.e. equivalent to ``oarsub``, ``qsub``, and ``salloc``.

Use Case 1.1
Request nodes outside of a slot
^^^^^^^^^^^^
Request nodes outside of a slot

Specific Example
Request 4 nodes, each with 1 slot
Expand All @@ -236,7 +236,8 @@ Jobspec YAML


Use Case 1.2
Request nodes inside of a slot
^^^^^^^^^^^^
Request nodes inside of a slot

Specific Example
Request 4 slots, each with 1 node
Expand All @@ -254,7 +255,8 @@ Jobspec YAML


Use Case 1.3
Request a fixed number of cores with no constraint on nodes
^^^^^^^^^^^^
Request a fixed number of cores with no constraint on nodes

Specific Example
Request 120 cores, one broker per node
Expand All @@ -277,7 +279,8 @@ and task counts.


Use Case 2.1
Run N tasks across M nodes, unequal distribution
^^^^^^^^^^^^
Run N tasks across M nodes, unequal distribution

Specific Example
Run 5 copies of ``hostname`` across 4 nodes,
Expand All @@ -292,8 +295,9 @@ Jobspec YAML
.. literalinclude:: data/spec_31/use_case_2.1.yaml
:language: yaml

Use Case 2.2
Run N tasks, Require M cores per task
Use Case 2.3
^^^^^^^^^^^^
Run N tasks, Require M cores per task

Specific Example
Run 10 copies of ``myapp``, require 2 cores per copy,
Expand All @@ -308,8 +312,9 @@ Jobspec YAML
.. literalinclude:: data/spec_31/use_case_2.2.yaml
:language: yaml

Use Case 2.3
Run N tasks, Require M cores and J gpus per task
Use Case 2.4
^^^^^^^^^^^^
Run N tasks, Require M cores and J gpus per task

Specific Example
Run 10 copies of ``myapp``, require 2 cores and 1 gpu per copy,
Expand All @@ -319,8 +324,9 @@ Jobspec YAML
.. literalinclude:: data/spec_31/use_case_2.3.yaml
:language: yaml

Use Case 2.4
Run N tasks across M nodes, each task with 1 core and 1 gpu
Use Case 2.5
^^^^^^^^^^^^
Run N tasks across M nodes, each task with 1 core and 1 gpu

Specific Example
Run 16 copies of ``myapp`` across 4 nodes, each copy with
Expand All @@ -335,8 +341,9 @@ Jobspec YAML
.. literalinclude:: data/spec_31/use_case_2.4.yaml
:language: yaml

Use Case 2.5
Specify dependencies
Use Case 2.6
^^^^^^^^^^^^
Specify dependencies

Specific Example
Depend on two previously submitted jobs. The first job’s
Expand Down

0 comments on commit 528e150

Please sign in to comment.