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 #6039

Merged
merged 60 commits into from
Dec 3, 2024
Merged

Skip Mode #6039

merged 60 commits into from
Dec 3, 2024

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented Mar 27, 2024

Closes #5641
closes #5820

Skip Mode Proposal Doc

This branch includes (marked against skip mode proposal):

  1. A new task run mode called "skip" to sit alongside the existing "live" and "simulation" and "dummy" modes.
  2. Skip mode settings in `[runtime][<namespace>][skip].
  3. Task-level control of the run mode - allowing run mode of tasks to override that of the workflow using [runtime][<namespace>]run mode.
    a. Broadcast can change run mode for future task job submissions.
    b. Cylc Validate and lint will warn about the setting not being live.
  4. cylc set --out skip sets outputs from skip mode.
  5. Tests to ensure that run mode = skip respects is_held flag.
  6. Tests to ensure that force triggering a task will not override the run mode.

Extras
7. Run Mode is available as an task attribute in the UI
8. When tasks are run in skip mode, the prerequisites which correspond to the outputs they generate should be marked as satisfied by skip mode rather than satisfied naturally for provenance reasons. For the purpose of cylc remove logic, satisfied by skip mode should be treated the same as satisfied naturally.

There are two extensions, which I haven't dealt with yet, because I want to ensure that the basic functionality works, and move to the substantial documentation PR which need follow this.

Check List

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
  • Tests are included (or explain why tests are not needed).
  • CHANGES.md entry included if this is a change that can affect users
  • Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
  • Feature: PR against master

@wxtim wxtim marked this pull request as draft March 27, 2024 12:57
@wxtim wxtim force-pushed the feature.skip_mode branch 2 times, most recently from b43d296 to d26c315 Compare March 28, 2024 09:11
@oliver-sanders oliver-sanders added this to the cylc-8.x milestone Apr 2, 2024
@wxtim wxtim self-assigned this Apr 22, 2024
@wxtim wxtim force-pushed the feature.skip_mode branch from d378e3a to e9c2e25 Compare April 22, 2024 13:57
@wxtim wxtim requested review from oliver-sanders, markgrahamdawson and MetRonnie and removed request for markgrahamdawson April 23, 2024 10:00
@wxtim wxtim marked this pull request as ready for review April 23, 2024 14:26
@MetRonnie MetRonnie modified the milestones: 8.x, 8.4.0 Apr 23, 2024
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
@MetRonnie MetRonnie added the config change Involves a change to global or workflow config label Apr 23, 2024
@wxtim wxtim requested a review from MetRonnie April 24, 2024 15:10
@wxtim wxtim force-pushed the feature.skip_mode branch 4 times, most recently from 3d002ee to dd0a9fc Compare April 25, 2024 12:56
@wxtim wxtim force-pushed the feature.skip_mode branch from dd0a9fc to 19faa47 Compare May 2, 2024 12:46
cylc/flow/prerequisite.py Outdated Show resolved Hide resolved
cylc/flow/scheduler_cli.py Outdated Show resolved Hide resolved
cylc/flow/task_state.py Outdated Show resolved Hide resolved
cylc/flow/task_state.py Outdated Show resolved Hide resolved
cylc/flow/task_state.py Outdated Show resolved Hide resolved
cylc/flow/scheduler.py Outdated Show resolved Hide resolved
cylc/flow/scheduler.py Outdated Show resolved Hide resolved
cylc/flow/task_pool.py Outdated Show resolved Hide resolved
@wxtim wxtim force-pushed the feature.skip_mode branch 3 times, most recently from 0d42eab to c37ef72 Compare May 8, 2024 12:43
@wxtim wxtim requested a review from MetRonnie May 8, 2024 13:47
@wxtim wxtim force-pushed the feature.skip_mode branch 2 times, most recently from 3839a8a to d7ee653 Compare May 9, 2024 08:50
@wxtim wxtim force-pushed the feature.skip_mode branch from 6677605 to 8de3073 Compare May 17, 2024 12:14
cylc/flow/network/schema.py Outdated Show resolved Hide resolved
cylc/flow/task_state.py Outdated Show resolved Hide resolved
cylc/flow/unicode_rules.py Outdated Show resolved Hide resolved
cylc/flow/task_proxy.py Outdated Show resolved Hide resolved
cylc/flow/task_pool.py Outdated Show resolved Hide resolved
cylc/flow/run_modes/skip.py Outdated Show resolved Hide resolved
cylc/flow/run_modes/skip.py Outdated Show resolved Hide resolved
cylc/flow/run_modes/nonlive.py Outdated Show resolved Hide resolved
cylc/flow/run_modes/nonlive.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
Make `cylc set --pre` & `cylc set --out skip` not override already-satisfied outputs
@wxtim wxtim requested a review from MetRonnie November 29, 2024 19:52
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.

I'm part way through this behemoth. Code LGreatTM, working well.

changes.d/6039.feat.md Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Show resolved Hide resolved
cylc/flow/run_modes/__init__.py Outdated Show resolved Hide resolved
cylc/flow/run_modes/__init__.py Outdated Show resolved Hide resolved
cylc/flow/run_modes/__init__.py Outdated Show resolved Hide resolved
cylc/flow/scheduler.py Outdated Show resolved Hide resolved
@wxtim wxtim force-pushed the feature.skip_mode branch from b1aca0d to 68cfd1c Compare December 2, 2024 10:48
@wxtim wxtim requested a review from hjoliver December 2, 2024 10:52
Co-authored-by: Hilary James Oliver <[email protected]>
@wxtim wxtim force-pushed the feature.skip_mode branch from 68cfd1c to f89719d Compare December 2, 2024 10:59
@wxtim wxtim requested a review from MetRonnie December 2, 2024 16:27
@wxtim wxtim force-pushed the feature.skip_mode branch from 13e20ed to 5a5432a Compare December 2, 2024 16:57
Copy link
Member

@MetRonnie MetRonnie left a comment

Choose a reason for hiding this comment

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

🥂

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.

One small suggestion. Great job @wxtim 🎉

cylc/flow/scheduler_cli.py Outdated Show resolved Hide resolved
wxtim and others added 2 commits December 3, 2024 07:27
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
cylc/flow/cfgspec/workflow.py Outdated Show resolved Hide resolved
@wxtim wxtim requested a review from MetRonnie December 3, 2024 11:43
@oliver-sanders
Copy link
Member

oliver-sanders commented Dec 3, 2024

🎉

Congrats Tim!

@oliver-sanders oliver-sanders merged commit 5b2b180 into cylc:master Dec 3, 2024
23 of 24 checks passed
@wxtim wxtim deleted the feature.skip_mode branch December 4, 2024 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config change Involves a change to global or workflow config schema change Change to the Cylc GraphQL schema
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dummy mode: subtract err-script from jobs skip mode
4 participants