Skip to content

Commit 2eb560e

Browse files
committed
doc: document per-resource options in flux-mini(1)
Problem: The per-resource options are not documented in the flux-mini(1) manpage. Reorganize the man page description of job options into "common", "per task" and "per resource" sections as they now appear in the --help output. Add entries for all the per-resource options.
1 parent d1fc85f commit 2eb560e

File tree

1 file changed

+54
-15
lines changed

1 file changed

+54
-15
lines changed

doc/man1/flux-mini.rst

Lines changed: 54 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,34 @@ JOB PARAMETERS
6464
These commands accept only the simplest parameters for expressing
6565
the size of the parallel program and the geometry of its task slots:
6666

67-
The **run** and **submit** commands take the following options to specify
68-
the size of the job request:
67+
Common resource options
68+
-----------------------
69+
70+
All subcommands take the following common resource allocation options:
71+
72+
**-N, --nodes=N**
73+
Set the number of nodes to assign to the job. Tasks will be distributed
74+
evenly across the allocated nodes, unless the per-resource options
75+
(noted below) are used with *submit*, *run*, or *bulksubmit*. It is
76+
an error to request more nodes than there are tasks. If unspecified,
77+
the number of nodes will be chosen by the scheduler.
78+
79+
**--exclusive**
80+
Indicate to the scheduler that nodes should be exclusively allocated to
81+
this job. It is an error to specify this option without also using
82+
*-N, --nodes*. If *--nodes* is specified without *--nslots* or *--ntasks*,
83+
then this option will be enabled by default and the number of tasks
84+
or slots will be set to the number of requested nodes.
85+
86+
87+
Per-task options
88+
----------------
89+
90+
The **run**, **submit** and **bulksubmit** commands take two sets
91+
of mutually exclusive options to specify the size of the job request.
92+
The most common form uses the total number of tasks to run along with
93+
the amount of resources required per task to specify the resources for
94+
the entire job:
6995

7096
**-n, --ntasks=N**
7197
Set the number of tasks to launch (default 1).
@@ -76,6 +102,29 @@ the size of the job request:
76102
**-g, --gpus-per-task=N**
77103
Set the number of GPU devices to assign to each task (default none).
78104

105+
Per-resource options
106+
--------------------
107+
108+
The second set of options allows an amount of resources to be specified
109+
with the number of tasks per core or node set on the command line. It is
110+
an error to specify any of these options when using any per-task option
111+
listed above:
112+
113+
**--cores=N**
114+
Set the total number of cores.
115+
116+
**--tasks-per-node=N**
117+
Set the number of tasks per node to run.
118+
119+
**--tasks-per-core=N**
120+
Force a number of tasks per core.
121+
122+
**--gpus-per-node=N**
123+
With -N, --nodes, request a specific number of GPUs per node.
124+
125+
Batch job options
126+
-----------------
127+
79128
The **batch** and **alloc** commands do not launch tasks directly, and
80129
therefore job parameters are specified in terms of resource slot size
81130
and number of slots. A resource slot can be thought of as the minimal
@@ -90,22 +139,12 @@ resources required for a virtual task. The default slot size is 1 core.
90139
**-g, --gpus-per-slot=N**
91140
Set the number of GPU devices to assign to each slot (default none).
92141

142+
Additional job options
143+
----------------------
144+
93145
The **run**, **submit**, **batch**, and **alloc** commands also take
94146
following additional job parameters:
95147

96-
**-N, --nodes=N**
97-
Set the number of nodes to assign to the job. Tasks will be distributed
98-
evenly across the allocated nodes. It is an error to request more nodes
99-
than there are tasks. If unspecified, the number of nodes will be chosen
100-
by the scheduler.
101-
102-
**--exclusive**
103-
Indicate to the scheduler that nodes should be exclusively allocated to
104-
this job. It is an error to specify this option without also using
105-
*-N, --nodes*. If *--nodes* is specified without *--nslots* or *--ntasks*,
106-
then this option will be enabled by default and the number of tasks
107-
or slots will be set to the number of requested nodes.
108-
109148
**-t, --time-limit=FSD**
110149
Set a time limit for the job in Flux standard duration (RFC 23).
111150
FSD is a floating point number with a single character units suffix

0 commit comments

Comments
 (0)