Retry a task

Retry one or more tasks. This creates a new task that copies the work of the old one. Most of the time this is transparent. We'll document this in the "advanced" vignette once it's written.

Usage

task_retry(id, driver = NULL, resources = NULL, root = NULL)

Arguments

id

The identifier or identifiers of tasks to retry.

driver

Name of the driver to use to submit the task. The default (NULL) depends on your configured drivers; if you have no drivers configured no submission happens (or indeed is possible). If you have exactly one driver configured we'll submit your task with it. If you have more than one driver configured, then we will error, though in future versions we may fall back on a default driver if you have one configured. If you pass FALSE here, submission is prevented even if you have no driver configured.

resources

A list generated by hipercow_resources giving the cluster resource requirements to run your task.

root

A hipercow root, or path to it. If NULL we search up your directory tree.

Value

New identifiers for the retried tasks

Details

This ends up being a little more complicated than ideal in order to keep things relatively fast, while keeping our usual guarantees about race conditions etc. Basically; retrying is the only way a task can move out of a terminal state but it still does not modify the existing task. Instead, we keep a separate register of whether a task has been retried or not. Each time we retry we write into this register. When you query about the status etc of a task you can then add a follow argument to control whether or not we check the register. We assume that you never call this in parallel; if you do then retries may be lost. You can run task_retry(NULL) to refresh the cached copy of the retry map if you need to.

Examples

cleanup <- hipercow_example_helper()
#> ℹ This example uses a special helper

# For demonstration, we just generate random numbers as then it's
# more obvious that things have been rerun:
id1 <- task_create_expr(runif(1))
#> ✔ Submitted task '52937eeeac8c13be8a199b48a04b9a14' using 'example'
task_wait(id1)
#> [1] TRUE
task_result(id1)
#> [1] 0.09541907

# Now retry the task and get the retried result:
id2 <- task_retry(id1)
#> ✔ Submitted task '03c8e97949ca8a487f203a1b57ccb4e3' using 'example'
task_wait(id2)
#> [1] TRUE
task_result(id2)
#> [1] 0.5280646

# After a retry, both the original and derived tasks know about
# each other:
task_info(id1)
#> 
#> ── task 52937eeeac8c13be8a199b48a04b9a14 (success) ─────────────────────────────
#> ℹ Submitted with 'example'
#> ℹ Task type: expression
#>   • Expression: runif(1)
#>   • Locals: (none)
#>   • Environment: default
#>     R_GC_MEM_GROW: 3
#> ℹ Created at 2024-10-08 15:27:20.132088 (moments ago)
#> ℹ Started at 2024-10-08 15:27:20.311639 (moments ago; waited 180ms)
#> ℹ Finished at 2024-10-08 15:27:20.400289 (moments ago; ran for 89ms)
#> ℹ 1st of a chain of a task retried 1 time, most recently '03c8e97949ca8a487f203a1b57ccb4e3'
task_info(id2)
#> 
#> ── task 03c8e97949ca8a487f203a1b57ccb4e3 (success) ─────────────────────────────
#> ℹ Submitted with 'example'
#> ℹ Task type: expression
#>   • Expression: runif(1)
#>   • Locals: (none)
#>   • Environment: default
#>     R_GC_MEM_GROW: 3
#> ℹ Created at 2024-10-08 15:27:20.132088 (moments ago)
#> ℹ Started at 2024-10-08 15:27:21.205109 (moments ago; waited 1.1s)
#> ℹ Finished at 2024-10-08 15:27:21.206077 (moments ago; ran for 1ms)
#> ℹ Last of a chain of a task retried 1 time

# By default every task will "follow" and access the most recent
# task in the chain:
task_result(id1) == task_result(id2)
#> [1] TRUE

# You can prevent this by passing follow = FALSE to get the value
# of this particular attempt:
task_result(id1, follow = FALSE)
#> [1] 0.09541907

# Tasks can be retried as many times as needed, creating a
# chain. It does not matter which task you retry as we always
# follow all the way to the end of the chain before retrying:
id3 <- task_retry(id1)
#> ✔ Submitted task 'abe5bdbc997e373d9f21a5e42f9dc44f' using 'example'
task_info(id1, follow = FALSE)
#> 
#> ── task 52937eeeac8c13be8a199b48a04b9a14 (submitted) ───────────────────────────
#> ℹ Submitted with 'example'
#> ℹ Task type: expression
#>   • Expression: runif(1)
#>   • Locals: (none)
#>   • Environment: default
#>     R_GC_MEM_GROW: 3
#> ℹ Created at 2024-10-08 15:27:20.132088 (moments ago)
#> ℹ Started at 2024-10-08 15:27:20.39769 (moments ago; waited 266ms)
#> ! Not finished yet (waiting to start)
#> ℹ 1st of a chain of a task retried 2 times, most recently 'abe5bdbc997e373d9f21a5e42f9dc44f'
task_info(id3)
#> 
#> ── task abe5bdbc997e373d9f21a5e42f9dc44f (success) ─────────────────────────────
#> ℹ Submitted with 'example'
#> ℹ Task type: expression
#>   • Expression: runif(1)
#>   • Locals: (none)
#>   • Environment: default
#>     R_GC_MEM_GROW: 3
#> ℹ Created at 2024-10-08 15:27:20.132088 (moments ago)
#> ℹ Started at 2024-10-08 15:27:22.312163 (moments ago; waited 2.2s)
#> ℹ Finished at 2024-10-08 15:27:22.313468 (moments ago; ran for 2ms)
#> ℹ Last of a chain of a task retried 2 times

cleanup()
#> ℹ Cleaning up example