Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Skip Mode #755

Merged
merged 1 commit into from
Dec 12, 2024
Merged

Skip Mode #755

merged 1 commit into from
Dec 12, 2024

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented Aug 12, 2024

Companion of cylc/cylc-flow#6039

Closes #783
Closes #784

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.

@wxtim wxtim force-pushed the content.skip_mode branch from 3af57b8 to 736d010 Compare August 12, 2024 10:19
@wxtim wxtim mentioned this pull request Aug 12, 2024
8 tasks
@wxtim wxtim force-pushed the content.skip_mode branch 2 times, most recently from 6c8ba68 to c4cd253 Compare October 4, 2024 10:57
@wxtim wxtim requested a review from oliver-sanders October 4, 2024 10:58
@wxtim wxtim requested a review from MetRonnie November 26, 2024 13:46
@oliver-sanders
Copy link
Member

Please could you update the advice for family-family triggering to make use of skip mode.

https://cylc.github.io/cylc-doc/stable/html/workflow-design-guide/efficiency.html#family-to-family-triggering

Worth skimming the docs to see if we document any other dummy task use cases anywhere.

@wxtim
Copy link
Member Author

wxtim commented Nov 29, 2024

Please could you update the advice for family-family triggering to make use of skip mode.

https://cylc.github.io/cylc-doc/stable/html/workflow-design-guide/efficiency.html#family-to-family-triggering

Worth skimming the docs to see if we document any other dummy task use cases anywhere.

Good call: I've realized responding to Ronnie's comments that we've somewhat overloaded the term dummy to mean

  • A task formally following the dummy task submission pathway
  • An informal dummy mode task (i.e. an implicit task) or a task with script = true.
  • A task which is a "dummy" with respect to it's graphing function. It can't be a true dummy task, but it could be a dummy like live task as described above, or a task carrying our some real work.

I've tried to remove either of the second two use cases for the word dummy.

I also found two references to "dummy-local" mode which hasn't been a thing for at least 3 years (I deleted it).

@wxtim wxtim requested a review from MetRonnie November 29, 2024 20:56
@hjoliver
Copy link
Member

hjoliver commented Dec 2, 2024

Good call: I've realized responding to Ronnie's comments that we've somewhat overloaded the term dummy to mean

Repeating my comment from the cylc-flow PR:

IMO opinion a "dummy task" is just a task that has no purpose beyond its role in the graph structure, i.e. it does not run a job that does anything useful at all. So dummy mode and simulation mode (and now skip mode) both (all) run dummy tasks.

However, it is potentially a bit confusing given the distinct mode names.

Now that we have (presumably) made simulation mode a lot more robust and useful ... can we consider ditching dummy mode? (we did discuss this somewhere once...). I'll put this question on the meeting agenda...

Either way, we should get the terminology straight and document it.

src/7-to-8/major-changes/cylc-install.rst Outdated Show resolved Hide resolved
src/user-guide/running-workflows/simulation-modes.rst Outdated Show resolved Hide resolved
src/user-guide/running-workflows/simulation-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/troubleshooting.rst Outdated Show resolved Hide resolved
src/user-guide/writing-workflows/scheduling.rst Outdated Show resolved Hide resolved
@wxtim wxtim force-pushed the content.skip_mode branch 4 times, most recently from 1f56820 to 4d9f535 Compare December 2, 2024 12:42
@wxtim wxtim requested a review from hjoliver December 2, 2024 12:42
@wxtim
Copy link
Member Author

wxtim commented Dec 2, 2024

I've tried to respond to comments from @MetRonnie and @hjoliver (if you're both saying the same thing I'll run with it).

After a certain amount of thought I've restored the references to dummy tasks and added some disambiguation in the glossary.

I've also renamed the two main files to reflect the difference between workflow and task run modes. To this end 4d9f535 contains actual changes, whilst 7408002 is just the file renaming.

Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good now, generally, just a bunch of minor suggestions.

src/glossary.rst Outdated Show resolved Hide resolved
src/user-guide/running-workflows/workflow-run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/running-workflows/workflow-run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/task-run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/task-run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/task-run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/task-run-modes.rst Outdated Show resolved Hide resolved
src/user-guide/task-implementation/task-run-modes.rst Outdated Show resolved Hide resolved
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I like your glossary entry on "dummy task".

@wxtim wxtim force-pushed the content.skip_mode branch from 494f040 to faeca94 Compare December 6, 2024 08:34
@wxtim wxtim requested a review from MetRonnie December 6, 2024 08:34
@wxtim wxtim marked this pull request as draft December 6, 2024 16:25
@wxtim wxtim added this to the 8.4.0 milestone Dec 6, 2024
@wxtim wxtim marked this pull request as ready for review December 10, 2024 08:02
Copy link
Member

@oliver-sanders oliver-sanders left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with fixes.

Add details of skip mode

move workflow run modes description back to simulation-modes.rst

change simulation-modes to workflow-run-modes

Update src/user-guide/running-workflows/workflow-run-modes.rst

Co-authored-by: Hilary James Oliver <[email protected]>

Update src/glossary.rst

Co-authored-by: Ronnie Dutta <[email protected]>

Update src/user-guide/task-implementation/task-run-modes.rst

rename task-run-modes.rst → skip-mode.rst

Update src/user-guide/interventions/index.rst

Co-authored-by: Oliver Sanders <[email protected]>

fix squiffy title levels

Update src/user-guide/task-implementation/skip-mode.rst

Co-authored-by: Oliver Sanders <[email protected]>

simplify config links by setting doc to approprate scop

fix directives
@wxtim wxtim force-pushed the content.skip_mode branch from 4f5b0a6 to ea416dd Compare December 12, 2024 09:58
@wxtim wxtim merged commit 4774245 into cylc:master Dec 12, 2024
1 check passed
@wxtim wxtim deleted the content.skip_mode branch December 12, 2024 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

interventions: skip a cycle changes: skip
4 participants