Cancel a pipeline

Writes a cancel request next to the pipeline record. The runner checks it between steps and stops there. A training step that is under way is asked to stop as well, the way dragon_cancel() does, so it saves a checkpoint first; a judging, synthesis, or merge step finishes before the pipeline stops. With wait = TRUE the call returns once the pipeline has stopped, killing the pipeline process if it is still going after timeout seconds.

Usage

dragon_pipeline_cancel(
  x,
  runs_dir = dragon_runs_dir(),
  wait = TRUE,
  timeout = 120
)

Arguments

x

A dragon_pipeline handle or a pipeline id.

runs_dir

Where the pipeline record lives, when x is an id.

wait

Wait for the pipeline to stop.

timeout

Seconds to wait before killing the pipeline process.

Value

The pipeline status, invisibly.