Skip to content

Commit e76f586

Browse files
committed
Fix runahead limit documentation.
1 parent 23f5c7a commit e76f586

File tree

1 file changed

+28
-20
lines changed

1 file changed

+28
-20
lines changed

src/user-guide/writing-workflows/scheduling.rst

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2351,6 +2351,8 @@ held back, and are displayed in the GUI/Tui with a small circle above them.
23512351

23522352
Tasks in the :term:`n>=1 window <n-window>` are not displayed as runahead
23532353
limited; they form the future graph and are not yet being actively limited.
2354+
(Note this goes for all tasks downstream of actively limited ones, not just
2355+
those in future cycles).
23542356

23552357
As the workflow advances and active cycles complete, the runahead limit moves
23562358
forward allowing tasks in later cycles to run.
@@ -2385,13 +2387,19 @@ is four cycles after this (i.e. cycle 4). So the task ``foo`` will immediately
23852387
submit in cycles 1, 2, 3 and 4, however, the tasks in cycles 5 onwards will
23862388
wait until earlier cycles complete, and the runahead limit advances.
23872389

2388-
* 1 |task-submitted| - **initial cycle point**
2389-
* 2 |task-submitted|
2390-
* 3 |task-submitted|
2391-
* 4 |task-submitted| - **runahead limit**
2392-
* 5 |task-runahead-super| (held back by runahead limit)
2393-
* 6 |task-runahead-super| (held back by runahead limit)
2394-
* X |task-runahead-super| (held back by runahead limit)
2390+
* 1 |task-submitted| - :term:`active task` at the **initial cycle point**
2391+
* 2 |task-submitted| - active task
2392+
* 3 |task-submitted| - active task
2393+
* 4 |task-submitted| - active task
2394+
* 5 |task-runahead-super| - active task, held back by the **runahead limit**
2395+
* 6 |task-waiting| - (future task, beyond the runahead limit)
2396+
* ...
2397+
2398+
.. note::
2399+
2400+
Depending on graph structure and :term:`n-window extent <n-window>` you
2401+
may see tasks beyond the runahead limit displayed as waiting. They form
2402+
the future graph and are not yet actively runahead limited.
23952403

23962404
As the workflow advances and earlier cycles complete, the runahead limit
23972405
moves on. E.G. Once the cycles 1 & 2 have completed, the runahead limit will
@@ -2412,13 +2420,13 @@ interval, so if we change the cycling interval from ``P1`` to ``P2Y``:
24122420
Then, the task ``foo`` would submit immediately in the cycles 1, 3, 5 and 7.
24132421
Cycles from 9 onwards will be held back.
24142422

2415-
* 2000 |task-submitted| - **initial cycle point**
2416-
* 2002 |task-submitted|
2417-
* 2004 |task-submitted|
2418-
* 2006 |task-submitted| - **runahead limit**
2419-
* 2008 |task-runahead-super| (held back by runahead limit)
2420-
* 2010 |task-runahead-super| (held back by runahead limit)
2421-
* XXXX |task-runahead-super| (held back by runahead limit)
2423+
* 2000 |task-submitted| - :term:`active task` at the **initial cycle point**
2424+
* 2002 |task-submitted| - active task
2425+
* 2004 |task-submitted| - active task
2426+
* 2006 |task-submitted| - active task
2427+
* 2008 |task-runahead-super| - active task, held back by the **runahead limit**
2428+
* 2010 |task-waiting| - (future task, beyond the runahead limit)
2429+
* ...
24222430

24232431

24242432
Datetime Format
@@ -2438,12 +2446,12 @@ This approach *does* depend on the cycling intervals, e.g:
24382446
24392447
When this workflow starts, the task foo in the first three cycles will run:
24402448

2441-
* 2000 |task-submitted| - **initial cycle point**
2442-
* 2002 |task-submitted|
2443-
* 2004 |task-submitted| - **runahead limit**
2444-
* 2006 |task-runahead-super| (held back by runahead limit)
2445-
* 2008 |task-runahead-super| (held back by runahead limit)
2446-
* XXXX |task-runahead-super| (held back by runahead limit)
2449+
* 2000 |task-submitted| - :term:`active task` at the **initial cycle point**
2450+
* 2002 |task-submitted| - active task
2451+
* 2004 |task-submitted| - active task
2452+
* 2006 |task-runahead-super| - active task, held back by the **runahead limit**
2453+
* 2008 |task-waiting| - (future task, beyond the runahead limit)
2454+
* ...
24472455

24482456

24492457
Runahead Limit Notes

0 commit comments

Comments
 (0)