From dd015fe562e34b6d6fbe7eadeb9abe5462935406 Mon Sep 17 00:00:00 2001
From: be-marc <33069354+be-marc@users.noreply.github.com>
Date: Mon, 4 Dec 2023 20:43:50 +0000
Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20mlr-org/?=
 =?UTF-8?q?rush@291f8d7e750d6f16bbf82253efa863f65e6105c3=20=F0=9F=9A=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 pkgdown.yml               |  2 +-
 reference/Rush.html       |  6 ++++++
 reference/RushWorker.html | 31 ++++++++++++++++++++++++++++---
 search.json               |  2 +-
 4 files changed, 36 insertions(+), 5 deletions(-)

diff --git a/pkgdown.yml b/pkgdown.yml
index 423a824..31535b8 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 2.19.2
 pkgdown: 2.0.7
 pkgdown_sha: ~
 articles: {}
-last_built: 2023-12-03T13:38Z
+last_built: 2023-12-04T20:43Z
 urls:
   reference: https://mlr3.mlr-org.com/reference
   article: https://mlr3.mlr-org.com/articles
diff --git a/reference/Rush.html b/reference/Rush.html
index 78ae843..ac7fc54 100644
--- a/reference/Rush.html
+++ b/reference/Rush.html
@@ -436,6 +436,7 @@ <h4 id="usage-3">Usage<a class="anchor" aria-label="anchor" href="#usage-3"></a>
 <span>  lgr_thresholds <span class="op">=</span> <span class="cn">NULL</span>,</span>
 <span>  lgr_buffer_size <span class="op">=</span> <span class="fl">0</span>,</span>
 <span>  max_retries <span class="op">=</span> <span class="fl">0</span>,</span>
+<span>  seed <span class="op">=</span> <span class="cn">NULL</span>,</span>
 <span>  supervise <span class="op">=</span> <span class="cn">TRUE</span>,</span>
 <span>  worker_loop <span class="op">=</span> <span class="va">worker_loop_default</span>,</span>
 <span>  <span class="va">...</span></span>
@@ -486,6 +487,11 @@ <h4 id="arguments-2">Arguments<a class="anchor" aria-label="anchor" href="#argum
 This improves the performance of the logging.</p></dd>
 
 
+<dt><code>seed</code></dt>
+<dd><p>(<code>integer(1)</code>)<br>
+Seed for the random number generator.</p></dd>
+
+
 <dt><code>supervise</code></dt>
 <dd><p>(<code>logical(1)</code>)<br>
 Whether to kill the workers when the main R process is shut down.</p></dd>
diff --git a/reference/RushWorker.html b/reference/RushWorker.html
index 02d0fa3..423478b 100644
--- a/reference/RushWorker.html
+++ b/reference/RushWorker.html
@@ -127,6 +127,7 @@ <h3 id="public-methods">Public methods<a class="anchor" aria-label="anchor" href
 <li><p><a href="#method-RushWorker-pop_task"><code>RushWorker$pop_task()</code></a></p></li>
 <li><p><a href="#method-RushWorker-push_results"><code>RushWorker$push_results()</code></a></p></li>
 <li><p><a href="#method-RushWorker-push_failed"><code>RushWorker$push_failed()</code></a></p></li>
+<li><p><a href="#method-RushWorker-set_seed"><code>RushWorker$set_seed()</code></a></p></li>
 <li><p><a href="#method-RushWorker-set_terminated"><code>RushWorker$set_terminated()</code></a></p></li>
 <li><p><a href="#method-RushWorker-clone"><code>RushWorker$clone()</code></a></p></li>
 </ul></div><p><details><summary>Inherited methods</summary><ul><li><span class="pkg-link" data-pkg="rush" data-topic="Rush" data-id="create_worker_script"><a href="../../rush/html/Rush.html#method-Rush-create_worker_script"><code>rush::Rush$create_worker_script()</code></a></span></li>
@@ -168,6 +169,7 @@ <h4 id="usage">Usage<a class="anchor" aria-label="anchor" href="#usage"></a></h4
 <span>  heartbeat_expire <span class="op">=</span> <span class="cn">NULL</span>,</span>
 <span>  lgr_thresholds <span class="op">=</span> <span class="cn">NULL</span>,</span>
 <span>  lgr_buffer_size <span class="op">=</span> <span class="fl">0</span>,</span>
+<span>  seed <span class="op">=</span> <span class="cn">NULL</span>,</span>
 <span>  max_retries <span class="op">=</span> <span class="fl">0</span></span>
 <span><span class="op">)</span></span></code></pre></div><p></p></div>
 </div>
@@ -224,6 +226,11 @@ <h4 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#argumen
 This improves the performance of the logging.</p></dd>
 
 
+<dt><code>seed</code></dt>
+<dd><p>(<code>integer(1)</code>)<br>
+Seed for the random number generator.</p></dd>
+
+
 </dl><p></p></div>
 </div>
 
@@ -325,11 +332,29 @@ <h4 id="usage-4">Usage<a class="anchor" aria-label="anchor" href="#usage-4"></a>
 </div>
 
 
+</div><p></p><hr><a id="method-RushWorker-set_seed"></a><div class="section">
+<h3 id="method-set-seed-">Method <code>set_seed()</code><a class="anchor" aria-label="anchor" href="#method-set-seed-"></a></h3>
+<p>Sets the seed for <code>key</code>.
+Updates the seed table if necessary.</p><div class="section">
+<h4 id="usage-5">Usage<a class="anchor" aria-label="anchor" href="#usage-5"></a></h4>
+<p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">RushWorker</span><span class="op">$</span><span class="fu">set_seed</span><span class="op">(</span><span class="va">key</span><span class="op">)</span></span></code></pre></div><p></p></div>
+</div>
+
+<div class="section">
+<h4 id="arguments-4">Arguments<a class="anchor" aria-label="anchor" href="#arguments-4"></a></h4>
+<p></p><div class="arguments"><dl><dt><code>key</code></dt>
+<dd><p>(<code>character(1)</code>)<br>
+Key of the task.</p></dd>
+
+
+</dl><p></p></div>
+</div>
+
 </div><p></p><hr><a id="method-RushWorker-set_terminated"></a><div class="section">
 <h3 id="method-set-terminated-">Method <code>set_terminated()</code><a class="anchor" aria-label="anchor" href="#method-set-terminated-"></a></h3>
 <p>Mark the worker as terminated.
 Last step in the worker loop before the worker terminates.</p><div class="section">
-<h4 id="usage-5">Usage<a class="anchor" aria-label="anchor" href="#usage-5"></a></h4>
+<h4 id="usage-6">Usage<a class="anchor" aria-label="anchor" href="#usage-6"></a></h4>
 <p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">RushWorker</span><span class="op">$</span><span class="fu">set_terminated</span><span class="op">(</span><span class="op">)</span></span></code></pre></div><p></p></div>
 </div>
 
@@ -337,12 +362,12 @@ <h4 id="usage-5">Usage<a class="anchor" aria-label="anchor" href="#usage-5"></a>
 </div><p></p><hr><a id="method-RushWorker-clone"></a><div class="section">
 <h3 id="method-clone-">Method <code>clone()</code><a class="anchor" aria-label="anchor" href="#method-clone-"></a></h3>
 <p>The objects of this class are cloneable with this method.</p><div class="section">
-<h4 id="usage-6">Usage<a class="anchor" aria-label="anchor" href="#usage-6"></a></h4>
+<h4 id="usage-7">Usage<a class="anchor" aria-label="anchor" href="#usage-7"></a></h4>
 <p></p><div class="r"><div class="sourceCode"><pre><code><span><span class="va">RushWorker</span><span class="op">$</span><span class="fu">clone</span><span class="op">(</span>deep <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div><p></p></div>
 </div>
 
 <div class="section">
-<h4 id="arguments-4">Arguments<a class="anchor" aria-label="anchor" href="#arguments-4"></a></h4>
+<h4 id="arguments-5">Arguments<a class="anchor" aria-label="anchor" href="#arguments-5"></a></h4>
 <p></p><div class="arguments"><dl><dt><code>deep</code></dt>
 <dd><p>Whether to make a deep clone.</p></dd>
 
diff --git a/search.json b/search.json
index aefc595..f55fc60 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":"https://mlr3.mlr-org.com/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Marc Becker. Maintainer, author.","code":""},{"path":"https://mlr3.mlr-org.com/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Becker M (2023). rush: Parallel Distributed Programming. R package version 0.0.0.9000.","code":"@Manual{,   title = {rush: Parallel and Distributed Programming},   author = {Marc Becker},   year = {2023},   note = {R package version 0.0.0.9000}, }"},{"path":"https://mlr3.mlr-org.com/index.html","id":"rush","dir":"","previous_headings":"","what":"Parallel and Distributed Programming","title":"Parallel and Distributed Programming","text":"rush package parallel distributed computing R. evaluates R expression asynchronously cluster workers provides shared storage workers. shared storage Redis data base. Rush offers centralized decentralized network architecture. centralized network single controller (Rush) multiple workers (RushWorker). Tasks created centrally distributed workers controller. decentralized network controller. workers sample tasks communicate results asynchronously workers.","code":""},{"path":"https://mlr3.mlr-org.com/index.html","id":"features","dir":"","previous_headings":"","what":"Features","title":"Parallel and Distributed Programming","text":"Parallelize arbitrary R expressions. Centralized decentralized network architecture. Small overhead milliseconds per task. Easy start local workers processx Start workers platform batch script. Designed work data.table. Results cached R session minimize read write operations. Detect recover worker failures. Start heartbeats monitor workers remote machines. Snapshot -memory data base disk. Store lgr messages workers Redis data base. Light dependencies.","code":""},{"path":"https://mlr3.mlr-org.com/index.html","id":"install","dir":"","previous_headings":"","what":"Install","title":"Parallel and Distributed Programming","text":"Install development version GitHub. install Redis.","code":"remotes::install_github(\"mlr-org/rush\")"},{"path":"https://mlr3.mlr-org.com/index.html","id":"centralized-rush-network","dir":"","previous_headings":"","what":"Centralized Rush Network","title":"Parallel and Distributed Programming","text":"Centralized network single controller three workers. example shows evaluation simple function centralized network. network_id identifies instance workers network. config list parameters connection Redis. Next, define function want evaluate workers. start two workers. Now can push tasks workers. retrieve results.","code":"library(rush)  config = redux::redis_config() rush = Rush$new(network_id = \"test\", config)  rush ## <Rush> ## * Running Workers: 0 ## * Queued Tasks: 0 ## * Queued Priority Tasks: 0 ## * Running Tasks: 0 ## * Finished Tasks: 0 ## * Failed Tasks: 0 fun = function(x1, x2, ...) {   list(y = x1 + x2) } rush$start_workers(fun = fun, n_workers = 2) xss = list(list(x1 = 3, x2 = 5), list(x1 = 4, x2 = 6)) keys = rush$push_tasks(xss) rush$wait_for_tasks(keys) rush$fetch_finished_tasks() ##       x1    x2   pid                            worker_id     y    state ##    <num> <num> <int>                               <char> <num>   <char> ## 1:     4     6 40827 d4c55759-70d0-49ce-8d67-bd912fb184b9    10 finished ## 2:     3     5 40829 c80ec3fe-7656-47e4-97a7-33043c3db331     8 finished ##                                    keys ##                                  <char> ## 1: 2242649d-a29a-4624-ac2e-91b8d04be4fa ## 2: 0c2fa5d9-d012-488f-b8d6-e92266dc2837"},{"path":"https://mlr3.mlr-org.com/index.html","id":"decentralized-rush-network","dir":"","previous_headings":"","what":"Decentralized Rush Network","title":"Parallel and Distributed Programming","text":"Decentralized network four workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":null,"dir":"Reference","previous_headings":"","what":"Log to Redis Data Store — AppenderRedis","title":"Log to Redis Data Store — AppenderRedis","text":"AppenderRedis writes log messages Redis data store.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"Log to Redis Data Store — AppenderRedis","text":"lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> AppenderRedis","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Log to Redis Data Store — AppenderRedis","text":"lgr::Filterable$add_filter() lgr::Filterable$filter() lgr::Filterable$remove_filter() lgr::Filterable$set_filters() lgr::Appender$set_layout() lgr::Appender$set_threshold() lgr::AppenderMemory$append() lgr::AppenderMemory$clear() lgr::AppenderMemory$format() lgr::AppenderMemory$set_buffer_size() lgr::AppenderMemory$set_flush_on_exit() lgr::AppenderMemory$set_flush_on_rotate() lgr::AppenderMemory$set_flush_threshold() lgr::AppenderMemory$set_should_flush() lgr::AppenderMemory$show()","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Log to Redis Data Store — AppenderRedis","text":"AppenderRedis$new() AppenderRedis$flush()","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Log to Redis Data Store — AppenderRedis","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Log to Redis Data Store — AppenderRedis","text":"","code":"AppenderRedis$new(   config,   key,   threshold = NA_integer_,   layout = lgr::LayoutJson$new(),   buffer_size = 0,   flush_threshold = \"error\",   flush_on_exit = TRUE,   flush_on_rotate = TRUE,   should_flush = NULL,   filters = NULL )"},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Log to Redis Data Store — AppenderRedis","text":"config (redux::redis_config) Redis configuration options. key (character(1)) Key list holding log messages Redis data store. threshold (integer(1) | character(1)) Threshold log messages. layout (lgr::Layout) Layout log messages. buffer_size (integer(1)) Size buffer. flush_threshold (character(1)) Threshold flushing buffer. flush_on_exit (logical(1)) Flush buffer exit. flush_on_rotate (logical(1)) Flush buffer rotate. should_flush (function) Function determines buffer flushed. filters (list) List filters.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"method-flush-","dir":"Reference","previous_headings":"","what":"Method flush()","title":"Log to Redis Data Store — AppenderRedis","text":"Sends buffer's contents Redis data store, clears buffer.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Log to Redis Data Store — AppenderRedis","text":"","code":"AppenderRedis$flush()"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":null,"dir":"Reference","previous_headings":"","what":"Rush Controller — Rush","title":"Rush Controller — Rush","text":"Rush controller centralized rush network. controller starts stops workers, pushes tasks workers fetches results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"local-workers","dir":"Reference","previous_headings":"","what":"Local Workers","title":"Rush Controller — Rush","text":"local worker runs machine controller. Local workers spawned $start_workers() method via processx` package.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"remote-workers","dir":"Reference","previous_headings":"","what":"Remote Workers","title":"Rush Controller — Rush","text":"remote worker runs different machine controller. Remote workers started manually $create_worker_script() method. Remote workers can started system long system access Redis required packages installed. heartbeat process can kill remote workers. heartbeat process also monitors remote workers crashes.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"stopping-workers","dir":"Reference","previous_headings":"","what":"Stopping Workers","title":"Rush Controller — Rush","text":"Local remote workers can terminated $stop_workers(type = \"terminate\") method. workers evaluate currently running task terminate. option type = \"kill\" stops workers immediately. Killing local worker done tools::pskill() function. Remote workers killed pushing kill signal heartbeat process. Without heartbeat process remote worker killed (see section heartbeat).","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"heartbeat","dir":"Reference","previous_headings":"","what":"Heartbeat","title":"Rush Controller — Rush","text":"heartbeat process periodically signals worker still alive. implemented setting timeout heartbeat key. Furthermore, heartbeat process can kill worker.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"data-structure","dir":"Reference","previous_headings":"","what":"Data Structure","title":"Rush Controller — Rush","text":"Rush writes task result additional meta information Redis hash.   key hash identifies task Rush. fields written different methods, e.g. $push_result() writes ys result available. value field serialized list e.g. unserializing xs gives list(x1 = 1, x2 = 2). data structure allows quickly convert hash row join multiple hashes table. example, three hashes example converted following table.   Notice value field can store multiple columns table. methods $push_tasks() $push_results() write multiple hashes. example, $push_tasks(xss = list(list(x1 = 1, x2 = 2), list(x1 = 2, x2 = 2)) writes xs two hashes.","code":"key : xs | ys | extra | state | key | x1 | x2 | y | timestamp | state   | | 1.. |  3 |  4 | 7 |  12:04:11 | finished | | 2.. |  1 |  4 | 5 |  12:04:12 | finished | | 3.. |  1 |  1 | 2 |  12:04:13 | finished |"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"task-states","dir":"Reference","previous_headings":"","what":"Task States","title":"Rush Controller — Rush","text":"task can go four states \"queued\", \"running\", \"finished\" \"failed\". Internally, keys tasks pushed Redis lists sets keep track state. Queued tasks waiting evaluated. worker pops task queue changes state \"running\" evaluating task. task finished, state changed \"finished\" result written data base. task fails, state changed \"failed\"instead \"finished\"`.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"queues","dir":"Reference","previous_headings":"","what":"Queues","title":"Rush Controller — Rush","text":"Rush uses shared queue queue worker. shared queue used push tasks workers. first worker pops task shared queue evaluates task. worker queues used push tasks specific workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"fetch-tasks-and-results","dir":"Reference","previous_headings":"","what":"Fetch Tasks and Results","title":"Rush Controller — Rush","text":"$fetch_*() methods retrieve data Redis database. matching method defined task state e.g. $fetch_running_tasks() $fetch_finished_tasks(). result function evaluation needed, $fetch_results() $fetch_latest_results() faster. methods $fetch_results() $fetch_finished_tasks() cache already queried data. $block_*() variants wait new result available.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"error-handling","dir":"Reference","previous_headings":"","what":"Error Handling","title":"Rush Controller — Rush","text":"evaluating tasks distributed system, many things can go wrong. Simple R errors worker loop caught written archive. task marked \"failed\". connection worker lost, looks like task \"running\" forever. methods $detect_lost_workers() $detect_lost_tasks() detect lost workers. Running methods periodically adds small overhead.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"logging","dir":"Reference","previous_headings":"","what":"Logging","title":"Rush Controller — Rush","text":"worker logs messages written lgr package data base. lgr_thresholds argument defines logging level logger e.g. c(rush = \"debug\"). Saving log messages adds small overhead useful debugging. default, log messages stored.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Rush Controller — Rush","text":"network_id (character(1)) Identifier rush network. config (redux::redis_config) Redis configuration options. connector (redux::redis_api) Returns connection Redis. processes (processx::process) List processes started $start_workers().","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Rush Controller — Rush","text":"n_workers (integer(1)) Number workers. n_running_workers (integer(1)) Number running workers. worker_ids (character()) Ids workers. running_worker_ids (character()) Ids running workers. terminated_worker_ids (character()) Ids terminated workers. killed_worker_ids (character()) Ids killed workers. lost_worker_ids (character()) Ids lost workers. tasks (character()) Keys tasks. queued_tasks (character()) Keys queued tasks. running_tasks (character()) Keys running tasks. finished_tasks (character()) Keys finished tasks. failed_tasks (character()) Keys failed tasks. n_queued_tasks (integer(1)) Number queued tasks. n_queued_priority_tasks (integer(1)) Number queued priority tasks. n_running_tasks (integer(1)) Number running tasks. n_finished_tasks (integer(1)) Number finished tasks. n_failed_tasks (integer(1)) Number failed tasks. n_tasks (integer(1)) Number tasks. data (data.table::data.table) Contains performed function calls. worker_info (data.table::data.table()) Contains information workers. worker_states (data.table::data.table()) Contains states workers. priority_info (data.table::data.table) Contains number tasks priority queues. snapshot_schedule (character()) Set snapshot schedule periodically save data base disk. example, c(60, 1000) saves data base every 60 seconds least 1000 changes. Overwrites redis configuration file. Set NULL disable snapshots. details see redis.io.","code":""},{"path":[]},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Rush Controller — Rush","text":"Rush$new() Rush$format() Rush$print() Rush$start_workers() Rush$restart_workers() Rush$create_worker_script() Rush$wait_for_workers() Rush$stop_workers() Rush$detect_lost_workers() Rush$reset() Rush$read_log() Rush$push_tasks() Rush$push_priority_tasks() Rush$fetch_latest_results() Rush$wait_for_latest_results() Rush$fetch_results() Rush$fetch_queued_tasks() Rush$fetch_priority_tasks() Rush$fetch_running_tasks() Rush$fetch_finished_tasks() Rush$wait_for_finished_tasks() Rush$fetch_failed_tasks() Rush$fetch_tasks() Rush$wait_for_tasks() Rush$write_hashes() Rush$read_hashes() Rush$n_tries() Rush$clone()","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Rush Controller — Rush","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$new(network_id = NULL, config = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. config (redux::redis_config) Redis configuration options. NULL, configuration set rush_plan() used. rush_plan() called, REDIS_URL environment variable parsed. REDIS_URL set, default configuration used. See redux::redis_config details.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-format-","dir":"Reference","previous_headings":"","what":"Method format()","title":"Rush Controller — Rush","text":"Helper print outputs.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$format(...)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"... (ignored).","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()).","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Rush Controller — Rush","text":"Print method.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$print()"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()).","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-start-workers-","dir":"Reference","previous_headings":"","what":"Method start_workers()","title":"Rush Controller — Rush","text":"Start workers locally processx. processx::process stored $processes. Alternatively, use $create_worker_script() create script starting workers remote machines. default, worker_loop_default() used worker loop. function takes arguments fun optionally constants passed ....","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$start_workers(   n_workers = NULL,   wait_for_workers = TRUE,   globals = NULL,   packages = NULL,   heartbeat_period = NULL,   heartbeat_expire = NULL,   lgr_thresholds = NULL,   lgr_buffer_size = 0,   max_retries = 0,   supervise = TRUE,   worker_loop = worker_loop_default,   ... )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"n_workers (integer(1)) Number workers started. wait_for_workers (logical(1)) Whether wait workers available. globals (character()) Global variables loaded workers global environment. packages (character()) Packages loaded workers. heartbeat_period (integer(1)) Period heartbeat seconds. heartbeat_expire (integer(1)) Time live heartbeat seconds. lgr_thresholds (named character() | named numeric()) Logger threshold workers e.g. c(rush = \"debug\"). lgr_buffer_size (integer(1)) default (lgr_buffer_size = 0), log messages directly saved Redis data store. lgr_buffer_size > 0, log messages buffered saved Redis data store buffer full. improves performance logging. supervise (logical(1)) Whether kill workers main R process shut . worker_loop (function) Loop run workers. Defaults worker_loop_default called fun. Pass fun .... ... () Arguments passed worker_loop.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-restart-workers-","dir":"Reference","previous_headings":"","what":"Method restart_workers()","title":"Rush Controller — Rush","text":"Restart workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$restart_workers(worker_ids)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"worker_ids (character()) Worker ids restarted.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-create-worker-script-","dir":"Reference","previous_headings":"","what":"Method create_worker_script()","title":"Rush Controller — Rush","text":"Create script start workers. worker started start_worker().","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$create_worker_script(   globals = NULL,   packages = NULL,   heartbeat_period = NULL,   heartbeat_expire = NULL,   lgr_thresholds = NULL,   lgr_buffer_size = 0,   worker_loop = worker_loop_default,   ... )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"globals (character()) Global variables loaded workers global environment. packages (character()) Packages loaded workers. heartbeat_period (integer(1)) Period heartbeat seconds. heartbeat_expire (integer(1)) Time live heartbeat seconds. lgr_thresholds (named character() | named numeric()) Logger threshold workers e.g. c(rush = \"debug\"). lgr_buffer_size (integer(1)) default (lgr_buffer_size = 0), log messages directly saved Redis data store. lgr_buffer_size > 0, log messages buffered saved Redis data store buffer full. improves performance logging. worker_loop (function) Loop run workers. Defaults worker_loop_default called fun. Pass fun .... ... () Arguments passed worker_loop.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-wait-for-workers-","dir":"Reference","previous_headings":"","what":"Method wait_for_workers()","title":"Rush Controller — Rush","text":"Wait n workers available.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$wait_for_workers(n)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"n (integer(1)) Number workers wait .","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-stop-workers-","dir":"Reference","previous_headings":"","what":"Method stop_workers()","title":"Rush Controller — Rush","text":"Stop workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$stop_workers(type = \"terminate\", worker_ids = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"type (character(1)) Type stopping. Either \"terminate\" \"kill\". \"terminate\" workers evaluate currently running task terminate. \"kill\" workers stopped immediately. worker_ids (character()) Worker ids stopped. NULL workers stopped.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-detect-lost-workers-","dir":"Reference","previous_headings":"","what":"Method detect_lost_workers()","title":"Rush Controller — Rush","text":"Detect lost workers. state worker changed \"lost\". Local workers without heartbeat checked process id. Checking local workers unix systems takes microseconds per worker. checking local workers windows might slow. Workers heartbeat process checked heartbeat. Lost tasks marked \"lost\".","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$detect_lost_workers(restart_workers = FALSE, restart_tasks = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"restart_workers (logical(1)) Whether restart lost workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-reset-","dir":"Reference","previous_headings":"","what":"Method reset()","title":"Rush Controller — Rush","text":"Stop workers delete data stored redis.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$reset(type = \"kill\")"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"type (character(1)) Type stopping. Either \"terminate\" \"kill\". \"terminate\" workers evaluate currently running task terminate. \"kill\" workers stopped immediately.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-read-log-","dir":"Reference","previous_headings":"","what":"Method read_log()","title":"Rush Controller — Rush","text":"Read log messages written lgr package worker.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$read_log(worker_ids = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"worker_ids (character(1)) Worker ids. NULL worker ids used.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-push-tasks-","dir":"Reference","previous_headings":"","what":"Method push_tasks()","title":"Rush Controller — Rush","text":"Pushes task queue. Task added queued tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$push_tasks(xss, extra = NULL, terminate_workers = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-10","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"xss (list named list()) Lists arguments function e.g. list(list(x1, x2), list(x1, x2))). extra (list) List additional information stored along task e.g. list(list(timestamp), list(timestamp))). terminate_workers (logical(1)) Whether stop workers evaluating tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()) Keys tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-push-priority-tasks-","dir":"Reference","previous_headings":"","what":"Method push_priority_tasks()","title":"Rush Controller — Rush","text":"Pushes task queue specific worker. Task added queued priority tasks. worker evaluates tasks priority queue shared queue. priority NA task added shared queue. worker lost worker id known, task added shared queue.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$push_priority_tasks(xss, extra = NULL, priority = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-11","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"xss (list named list()) Lists arguments function e.g. list(list(x1, x2), list(x1, x2))). extra (list) List additional information stored along task e.g. list(list(timestamp), list(timestamp))). priority (character()) Worker ids tasks pushed.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()) Keys tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-latest-results-","dir":"Reference","previous_headings":"","what":"Method fetch_latest_results()","title":"Rush Controller — Rush","text":"Fetch latest results data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_latest_results(fields = \"ys\", data_format = \"data.table\")"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-12","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Latest results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-wait-for-latest-results-","dir":"Reference","previous_headings":"","what":"Method wait_for_latest_results()","title":"Rush Controller — Rush","text":"Block process new result available. Returns latest results NULL result available timeout seconds.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$wait_for_latest_results(   fields = \"ys\",   timeout = Inf,   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-13","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. timeout (numeric(1)) Time wait result seconds. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Latest results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-results-","dir":"Reference","previous_headings":"","what":"Method fetch_results()","title":"Rush Controller — Rush","text":"Fetch results data base. Results cached.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_results(   fields = \"ys\",   reset_cache = FALSE,   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-14","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults \"ys\". reset_cache (logical(1)) Whether reset cache. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-6","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-queued-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_queued_tasks()","title":"Rush Controller — Rush","text":"Fetch queued tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-16","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_queued_tasks(   fields = c(\"xs\", \"xs_extra\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-15","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\"). data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-7","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table queued tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-priority-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_priority_tasks()","title":"Rush Controller — Rush","text":"Fetch queued priority tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-17","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_priority_tasks(   fields = c(\"xs\", \"xs_extra\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-16","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\"). data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-8","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table queued priority tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-running-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_running_tasks()","title":"Rush Controller — Rush","text":"Fetch running tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-18","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_running_tasks(   fields = c(\"xs\", \"xs_extra\", \"worker_extra\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-17","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\"). data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-9","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table running tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-finished-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_finished_tasks()","title":"Rush Controller — Rush","text":"Fetch finished tasks data base. Finished tasks cached.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-19","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_finished_tasks(   fields = c(\"xs\", \"ys\", \"xs_extra\", \"worker_extra\", \"ys_extra\"),   reset_cache = FALSE,   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-18","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\", \"ys\", \"ys_extra\"). reset_cache (logical(1)) Whether reset cache. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-10","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table finished tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-wait-for-finished-tasks-","dir":"Reference","previous_headings":"","what":"Method wait_for_finished_tasks()","title":"Rush Controller — Rush","text":"Block process new finished task available. Returns finished tasks NULL new task available timeout seconds.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-20","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$wait_for_finished_tasks(   fields = c(\"xs\", \"ys\", \"xs_extra\", \"worker_extra\", \"ys_extra\"),   timeout = Inf,   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-19","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\", \"ys\", \"ys_extra\"). timeout (numeric(1)) Time wait result seconds. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-11","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table finished tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-failed-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_failed_tasks()","title":"Rush Controller — Rush","text":"Fetch failed tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-21","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_failed_tasks(   fields = c(\"xs\", \"worker_extra\", \"condition\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-20","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\", \"condition\". data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-12","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table failed tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_tasks()","title":"Rush Controller — Rush","text":"Fetch tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-22","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_tasks(   fields = c(\"xs\", \"ys\", \"xs_extra\", \"worker_extra\", \"ys_extra\", \"condition\", \"state\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-21","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\", \"ys\", \"ys_extra\", \"condition\", \"state\"). data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-13","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-wait-for-tasks-","dir":"Reference","previous_headings":"","what":"Method wait_for_tasks()","title":"Rush Controller — Rush","text":"Wait tasks finished. function also unblocks worker running tasks failed.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-23","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$wait_for_tasks(keys, detect_lost_workers = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-22","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"keys (character()) Keys tasks wait . detect_lost_workers (logical(1)) Whether detect failed tasks. Comes overhead.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-write-hashes-","dir":"Reference","previous_headings":"","what":"Method write_hashes()","title":"Rush Controller — Rush","text":"Writes list redis hashes. function serializes element writes new hash. name argument defines field serialized element written. example, xs = list(list(x1 = 1, x2 = 2), list(x1 = 3, x2 = 4)) writes serialize(list(x1 = 1, x2 = 2)) field xs hash serialize(list(x1 = 3, x2 = 4)) field xs another hash. function can iterate multiple lists simultaneously. example, xs = list(list(x1 = 1, x2 = 2), list(x1 = 3, x2 = 4)), ys = list(list(y = 3), list(y = 7)) creates two hashes fields xs ys. Different lengths recycled. stored elements must lists . reading functions combine hashes table names inner lists column names. example, xs = list(list(x1 = 1, x2 = 2), list(x1 = 3, x2 = 4)), ys = list(list(y = 3), list(y = 7)) becomes data.table(x1 = c(1, 3), x2 = c(2, 4), y = c(3, 7)). Vectors list columns must wrapped lists. Otherwise, $read_values() expand table length vectors. example, xs = list(list(x1 = 1, x2 = 2)), xs_extra = list(list(extra = c(\"\", \"B\", \"C\"))) work. Pass xs_extra = list(list(extra = list(c(\"\", \"B\", \"C\"))))` instead.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-24","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$write_hashes(..., .values = list(), keys = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-23","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"... (named list()) Lists written hashes. names arguments used fields. .values (named list()) Lists written hashes. names list used fields. keys (character()) Keys hashes. NULL new keys generated.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-14","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()) Keys hashes.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-read-hashes-","dir":"Reference","previous_headings":"","what":"Method read_hashes()","title":"Rush Controller — Rush","text":"Reads redis hashes written $write_hashes(). function reads values fields hashes stored keys. values hash deserialized combined single list.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-25","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$read_hashes(keys, fields)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-24","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"keys (character()) Keys hashes. fields (character()) Fields read hashes.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-15","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(list list()) outer list contains one element key. inner list combination lists stored different fields.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-n-tries-","dir":"Reference","previous_headings":"","what":"Method n_tries()","title":"Rush Controller — Rush","text":"Returns number attempts evaluate task.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-26","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$n_tries(keys)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-25","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"keys (character()) Keys tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-16","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(integer()) Number attempts.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Rush Controller — Rush","text":"objects class cloneable method.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-27","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$clone(deep = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-26","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":null,"dir":"Reference","previous_headings":"","what":"Rush Worker — RushWorker","title":"Rush Worker — RushWorker","text":"RushWorker evaluates tasks writes results data base. worker inherits Rush.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Rush Worker — RushWorker","text":"worker registers data base rush network.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Rush Worker — RushWorker","text":"rush::Rush -> RushWorker","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Rush Worker — RushWorker","text":"worker_id (character(1)) Identifier worker. host (character(1)) Worker started local remote host. heartbeat (`r_process``) Background process heartbeat.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Rush Worker — RushWorker","text":"terminated (logical(1)) Whether shutdown worker. Used worker loop determine whether continue. terminated_on_idle (logical(1)) Whether shutdown worker tasks queued. Used worker loop determine whether continue.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Rush Worker — RushWorker","text":"rush::Rush$create_worker_script() rush::Rush$detect_lost_workers() rush::Rush$fetch_failed_tasks() rush::Rush$fetch_finished_tasks() rush::Rush$fetch_latest_results() rush::Rush$fetch_priority_tasks() rush::Rush$fetch_queued_tasks() rush::Rush$fetch_results() rush::Rush$fetch_running_tasks() rush::Rush$fetch_tasks() rush::Rush$format() rush::Rush$n_tries() rush::Rush$print() rush::Rush$push_priority_tasks() rush::Rush$push_tasks() rush::Rush$read_hashes() rush::Rush$read_log() rush::Rush$reset() rush::Rush$restart_workers() rush::Rush$start_workers() rush::Rush$stop_workers() rush::Rush$wait_for_finished_tasks() rush::Rush$wait_for_latest_results() rush::Rush$wait_for_tasks() rush::Rush$wait_for_workers() rush::Rush$write_hashes()","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Rush Worker — RushWorker","text":"RushWorker$new() RushWorker$push_running_task() RushWorker$pop_task() RushWorker$push_results() RushWorker$push_failed() RushWorker$set_terminated() RushWorker$clone()","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Rush Worker — RushWorker","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$new(   network_id,   config = NULL,   host,   worker_id = NULL,   heartbeat_period = NULL,   heartbeat_expire = NULL,   lgr_thresholds = NULL,   lgr_buffer_size = 0,   max_retries = 0 )"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. config (redux::redis_config) Redis configuration options. NULL, configuration set rush_plan() used. rush_plan() called, REDIS_URL environment variable parsed. REDIS_URL set, default configuration used. See redux::redis_config details. host (character(1)) Worker started local remote host. See Rush details. worker_id (character(1)) Identifier worker. Keys redis specific worker prefixed worker id. heartbeat_period (integer(1)) Period heartbeat seconds. heartbeat_expire (integer(1)) Time live heartbeat seconds. lgr_thresholds (named character() | named numeric()) Logger threshold workers e.g. c(rush = \"debug\"). lgr_buffer_size (integer(1)) default (lgr_buffer_size = 0), log messages directly saved Redis data store. lgr_buffer_size > 0, log messages buffered saved Redis data store buffer full. improves performance logging.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-push-running-task-","dir":"Reference","previous_headings":"","what":"Method push_running_task()","title":"Rush Worker — RushWorker","text":"Push task running tasks without queue.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$push_running_task(xss, extra = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"xss (list named list()) Lists arguments function e.g. list(list(x1, x2), list(x1, x2))). extra (list) List additional information stored along task e.g. list(list(timestamp), list(timestamp))).","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Worker — RushWorker","text":"(character()) Keys tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-pop-task-","dir":"Reference","previous_headings":"","what":"Method pop_task()","title":"Rush Worker — RushWorker","text":"Pop task queue. Task moved running tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$pop_task(timeout = 1)"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"timeout (numeric(1)) Time wait task seconds.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-push-results-","dir":"Reference","previous_headings":"","what":"Method push_results()","title":"Rush Worker — RushWorker","text":"Pushes results data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$push_results(   keys,   yss = list(),   extra = list(),   conditions = list() )"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"keys (character(1)) Keys associated tasks. yss (named list()) List lists named results. extra (named list()) List lists additional information stored along results. conditions (named list()) List lists conditions. state (character(1)) Status tasks. \"finished\" tasks moved finished tasks. \"error\" tasks moved failed tasks.","code":""},{"path":[]},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$push_failed(keys, conditions)"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-set-terminated-","dir":"Reference","previous_headings":"","what":"Method set_terminated()","title":"Rush Worker — RushWorker","text":"Mark worker terminated. Last step worker loop worker terminates.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$set_terminated()"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Rush Worker — RushWorker","text":"objects class cloneable method.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$clone(deep = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3.mlr-org.com/reference/get_hostname.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the computer name of the current host — get_hostname","title":"Get the computer name of the current host — get_hostname","text":"Returns computer name current host. First tries get computer name environment variables HOST, HOSTNAME COMPUTERNAME. fails tries get computer name function Sys.info(). Finally, fails queries computer name command uname -n. Copied R.utils package.","code":""},{"path":"https://mlr3.mlr-org.com/reference/get_hostname.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the computer name of the current host — get_hostname","text":"","code":"get_hostname()"},{"path":"https://mlr3.mlr-org.com/reference/heartbeat.html","id":null,"dir":"Reference","previous_headings":"","what":"Heartbeat Loop — heartbeat","title":"Heartbeat Loop — heartbeat","text":"heartbeat loop updates heartbeat key worker still alive. kill key set, worker killed.","code":""},{"path":"https://mlr3.mlr-org.com/reference/heartbeat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Heartbeat Loop — heartbeat","text":"","code":"heartbeat(   network_id,   config,   worker_id,   heartbeat_period,   heartbeat_expire,   pid )"},{"path":"https://mlr3.mlr-org.com/reference/heartbeat.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Heartbeat Loop — heartbeat","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. config (redux::redis_config) Redis configuration options. worker_id (character(1)) Identifier worker. Keys redis specific worker prefixed worker id. heartbeat_period (integer(1)) Period heartbeat seconds. heartbeat_expire (integer(1)) Time live heartbeat seconds. pid (integer(1)) Process ID worker.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rsh.html","id":null,"dir":"Reference","previous_headings":"","what":"Synctatic Sugar for Rush Controller Construction — rsh","title":"Synctatic Sugar for Rush Controller Construction — rsh","text":"Function construct Rush controller.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rsh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Synctatic Sugar for Rush Controller Construction — rsh","text":"","code":"rsh(network_id = NULL, config = NULL, ...)"},{"path":"https://mlr3.mlr-org.com/reference/rsh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Synctatic Sugar for Rush Controller Construction — rsh","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. config (redux::redis_config) Redis configuration options. NULL, configuration set rush_plan() used. rush_plan() called, REDIS_URL environment variable parsed. REDIS_URL set, default configuration used. See redux::redis_config details. ... (ignored).","code":""},{"path":"https://mlr3.mlr-org.com/reference/rsh.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Synctatic Sugar for Rush Controller Construction — rsh","text":"","code":"rsh(network_id = \"benchmark\") #> Error in initialize(...): Can't connect to Redis. Check the configuration."},{"path":"https://mlr3.mlr-org.com/reference/rush-package.html","id":null,"dir":"Reference","previous_headings":"","what":"rush: Parallel and Distributed Programming — rush-package","title":"rush: Parallel and Distributed Programming — rush-package","text":"Parallel programming package.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"rush: Parallel and Distributed Programming — rush-package","text":"Maintainer: Marc Becker marcbecker@posteo.de (ORCID)","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_available.html","id":null,"dir":"Reference","previous_headings":"","what":"Rush Available — rush_available","title":"Rush Available — rush_available","text":"Returns TRUE redis config file (redux::redis_config) set rush_plan().","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_available.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Available — rush_available","text":"","code":"rush_available()"},{"path":"https://mlr3.mlr-org.com/reference/rush_available.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rush Available — rush_available","text":"logical(1)","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_config.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Rush Config — rush_config","title":"Get Rush Config — rush_config","text":"Returns redis config file (redux::redis_config) set rush_plan().","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Rush Config — rush_config","text":"","code":"rush_config()"},{"path":"https://mlr3.mlr-org.com/reference/rush_config.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Rush Config — rush_config","text":"redux::redis_config() redis config file.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_plan.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Rush Plan — rush_plan","title":"Create Rush Plan — rush_plan","text":"Stores number workers Redis configuration options (redux::redis_config) Rush. function tests connection Redis throws error connection fails.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_plan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Rush Plan — rush_plan","text":"","code":"rush_plan(n_workers, config = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/rush_plan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Rush Plan — rush_plan","text":"n_workers (integer(1)) Number workers started. config (redux::redis_config) Configuration options used connect Redis. NULL, REDIS_URL environment variable parsed. REDIS_URL set, default configuration used. See redux::redis_config details.","code":""},{"path":"https://mlr3.mlr-org.com/reference/start_worker.html","id":null,"dir":"Reference","previous_headings":"","what":"Start a worker — start_worker","title":"Start a worker — start_worker","text":"Starts worker. function loads globals packages, initializes RushWorker instance invokes worker loop. function called $start_workers() user creating worker script $create_worker_script().","code":""},{"path":"https://mlr3.mlr-org.com/reference/start_worker.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Start a worker — start_worker","text":"","code":"start_worker(network_id, worker_id = NULL, hostname, ...)"},{"path":"https://mlr3.mlr-org.com/reference/start_worker.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Start a worker — start_worker","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. worker_id (character(1)) Identifier worker. Keys redis specific worker prefixed worker id. hostname (character(1)) Hostname rush controller instance. Used determine worker started local remote host. ... () Arguments passed redux::redis_config.","code":""},{"path":"https://mlr3.mlr-org.com/reference/start_worker.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Start a worker — start_worker","text":"function initializes connection Redis data base. loads packages copies globals global environment worker. function initialize RushWorker instance starts worker loop.","code":""},{"path":"https://mlr3.mlr-org.com/reference/worker_loop_default.html","id":null,"dir":"Reference","previous_headings":"","what":"Single Task Worker Loop — worker_loop_default","title":"Single Task Worker Loop — worker_loop_default","text":"Worker loop pops single task queue, executes function pushes results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/worker_loop_default.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Single Task Worker Loop — worker_loop_default","text":"","code":"worker_loop_default(fun, constants = NULL, rush)"},{"path":"https://mlr3.mlr-org.com/reference/worker_loop_default.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Single Task Worker Loop — worker_loop_default","text":"fun (function) Function executed. constants (list) List constants passed fun. rush (RushWorker) Rush worker instance.","code":""}]
+[{"path":"https://mlr3.mlr-org.com/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Marc Becker. Maintainer, author.","code":""},{"path":"https://mlr3.mlr-org.com/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Becker M (2023). rush: Parallel Distributed Programming. R package version 0.0.0.9000.","code":"@Manual{,   title = {rush: Parallel and Distributed Programming},   author = {Marc Becker},   year = {2023},   note = {R package version 0.0.0.9000}, }"},{"path":"https://mlr3.mlr-org.com/index.html","id":"rush","dir":"","previous_headings":"","what":"Parallel and Distributed Programming","title":"Parallel and Distributed Programming","text":"rush package parallel distributed computing R. evaluates R expression asynchronously cluster workers provides shared storage workers. shared storage Redis data base. Rush offers centralized decentralized network architecture. centralized network single controller (Rush) multiple workers (RushWorker). Tasks created centrally distributed workers controller. decentralized network controller. workers sample tasks communicate results asynchronously workers.","code":""},{"path":"https://mlr3.mlr-org.com/index.html","id":"features","dir":"","previous_headings":"","what":"Features","title":"Parallel and Distributed Programming","text":"Parallelize arbitrary R expressions. Centralized decentralized network architecture. Small overhead milliseconds per task. Easy start local workers processx Start workers platform batch script. Designed work data.table. Results cached R session minimize read write operations. Detect recover worker failures. Start heartbeats monitor workers remote machines. Snapshot -memory data base disk. Store lgr messages workers Redis data base. Light dependencies.","code":""},{"path":"https://mlr3.mlr-org.com/index.html","id":"install","dir":"","previous_headings":"","what":"Install","title":"Parallel and Distributed Programming","text":"Install development version GitHub. install Redis.","code":"remotes::install_github(\"mlr-org/rush\")"},{"path":"https://mlr3.mlr-org.com/index.html","id":"centralized-rush-network","dir":"","previous_headings":"","what":"Centralized Rush Network","title":"Parallel and Distributed Programming","text":"Centralized network single controller three workers. example shows evaluation simple function centralized network. network_id identifies instance workers network. config list parameters connection Redis. Next, define function want evaluate workers. start two workers. Now can push tasks workers. retrieve results.","code":"library(rush)  config = redux::redis_config() rush = Rush$new(network_id = \"test\", config)  rush ## <Rush> ## * Running Workers: 0 ## * Queued Tasks: 0 ## * Queued Priority Tasks: 0 ## * Running Tasks: 0 ## * Finished Tasks: 0 ## * Failed Tasks: 0 fun = function(x1, x2, ...) {   list(y = x1 + x2) } rush$start_workers(fun = fun, n_workers = 2) xss = list(list(x1 = 3, x2 = 5), list(x1 = 4, x2 = 6)) keys = rush$push_tasks(xss) rush$wait_for_tasks(keys) rush$fetch_finished_tasks() ##       x1    x2   pid                            worker_id     y    state ##    <num> <num> <int>                               <char> <num>   <char> ## 1:     4     6 40827 d4c55759-70d0-49ce-8d67-bd912fb184b9    10 finished ## 2:     3     5 40829 c80ec3fe-7656-47e4-97a7-33043c3db331     8 finished ##                                    keys ##                                  <char> ## 1: 2242649d-a29a-4624-ac2e-91b8d04be4fa ## 2: 0c2fa5d9-d012-488f-b8d6-e92266dc2837"},{"path":"https://mlr3.mlr-org.com/index.html","id":"decentralized-rush-network","dir":"","previous_headings":"","what":"Decentralized Rush Network","title":"Parallel and Distributed Programming","text":"Decentralized network four workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":null,"dir":"Reference","previous_headings":"","what":"Log to Redis Data Store — AppenderRedis","title":"Log to Redis Data Store — AppenderRedis","text":"AppenderRedis writes log messages Redis data store.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"Log to Redis Data Store — AppenderRedis","text":"lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> AppenderRedis","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Log to Redis Data Store — AppenderRedis","text":"lgr::Filterable$add_filter() lgr::Filterable$filter() lgr::Filterable$remove_filter() lgr::Filterable$set_filters() lgr::Appender$set_layout() lgr::Appender$set_threshold() lgr::AppenderMemory$append() lgr::AppenderMemory$clear() lgr::AppenderMemory$format() lgr::AppenderMemory$set_buffer_size() lgr::AppenderMemory$set_flush_on_exit() lgr::AppenderMemory$set_flush_on_rotate() lgr::AppenderMemory$set_flush_threshold() lgr::AppenderMemory$set_should_flush() lgr::AppenderMemory$show()","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Log to Redis Data Store — AppenderRedis","text":"AppenderRedis$new() AppenderRedis$flush()","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Log to Redis Data Store — AppenderRedis","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Log to Redis Data Store — AppenderRedis","text":"","code":"AppenderRedis$new(   config,   key,   threshold = NA_integer_,   layout = lgr::LayoutJson$new(),   buffer_size = 0,   flush_threshold = \"error\",   flush_on_exit = TRUE,   flush_on_rotate = TRUE,   should_flush = NULL,   filters = NULL )"},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Log to Redis Data Store — AppenderRedis","text":"config (redux::redis_config) Redis configuration options. key (character(1)) Key list holding log messages Redis data store. threshold (integer(1) | character(1)) Threshold log messages. layout (lgr::Layout) Layout log messages. buffer_size (integer(1)) Size buffer. flush_threshold (character(1)) Threshold flushing buffer. flush_on_exit (logical(1)) Flush buffer exit. flush_on_rotate (logical(1)) Flush buffer rotate. should_flush (function) Function determines buffer flushed. filters (list) List filters.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"method-flush-","dir":"Reference","previous_headings":"","what":"Method flush()","title":"Log to Redis Data Store — AppenderRedis","text":"Sends buffer's contents Redis data store, clears buffer.","code":""},{"path":"https://mlr3.mlr-org.com/reference/AppenderRedis.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Log to Redis Data Store — AppenderRedis","text":"","code":"AppenderRedis$flush()"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":null,"dir":"Reference","previous_headings":"","what":"Rush Controller — Rush","title":"Rush Controller — Rush","text":"Rush controller centralized rush network. controller starts stops workers, pushes tasks workers fetches results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"local-workers","dir":"Reference","previous_headings":"","what":"Local Workers","title":"Rush Controller — Rush","text":"local worker runs machine controller. Local workers spawned $start_workers() method via processx` package.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"remote-workers","dir":"Reference","previous_headings":"","what":"Remote Workers","title":"Rush Controller — Rush","text":"remote worker runs different machine controller. Remote workers started manually $create_worker_script() method. Remote workers can started system long system access Redis required packages installed. heartbeat process can kill remote workers. heartbeat process also monitors remote workers crashes.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"stopping-workers","dir":"Reference","previous_headings":"","what":"Stopping Workers","title":"Rush Controller — Rush","text":"Local remote workers can terminated $stop_workers(type = \"terminate\") method. workers evaluate currently running task terminate. option type = \"kill\" stops workers immediately. Killing local worker done tools::pskill() function. Remote workers killed pushing kill signal heartbeat process. Without heartbeat process remote worker killed (see section heartbeat).","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"heartbeat","dir":"Reference","previous_headings":"","what":"Heartbeat","title":"Rush Controller — Rush","text":"heartbeat process periodically signals worker still alive. implemented setting timeout heartbeat key. Furthermore, heartbeat process can kill worker.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"data-structure","dir":"Reference","previous_headings":"","what":"Data Structure","title":"Rush Controller — Rush","text":"Rush writes task result additional meta information Redis hash.   key hash identifies task Rush. fields written different methods, e.g. $push_result() writes ys result available. value field serialized list e.g. unserializing xs gives list(x1 = 1, x2 = 2). data structure allows quickly convert hash row join multiple hashes table. example, three hashes example converted following table.   Notice value field can store multiple columns table. methods $push_tasks() $push_results() write multiple hashes. example, $push_tasks(xss = list(list(x1 = 1, x2 = 2), list(x1 = 2, x2 = 2)) writes xs two hashes.","code":"key : xs | ys | extra | state | key | x1 | x2 | y | timestamp | state   | | 1.. |  3 |  4 | 7 |  12:04:11 | finished | | 2.. |  1 |  4 | 5 |  12:04:12 | finished | | 3.. |  1 |  1 | 2 |  12:04:13 | finished |"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"task-states","dir":"Reference","previous_headings":"","what":"Task States","title":"Rush Controller — Rush","text":"task can go four states \"queued\", \"running\", \"finished\" \"failed\". Internally, keys tasks pushed Redis lists sets keep track state. Queued tasks waiting evaluated. worker pops task queue changes state \"running\" evaluating task. task finished, state changed \"finished\" result written data base. task fails, state changed \"failed\"instead \"finished\"`.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"queues","dir":"Reference","previous_headings":"","what":"Queues","title":"Rush Controller — Rush","text":"Rush uses shared queue queue worker. shared queue used push tasks workers. first worker pops task shared queue evaluates task. worker queues used push tasks specific workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"fetch-tasks-and-results","dir":"Reference","previous_headings":"","what":"Fetch Tasks and Results","title":"Rush Controller — Rush","text":"$fetch_*() methods retrieve data Redis database. matching method defined task state e.g. $fetch_running_tasks() $fetch_finished_tasks(). result function evaluation needed, $fetch_results() $fetch_latest_results() faster. methods $fetch_results() $fetch_finished_tasks() cache already queried data. $block_*() variants wait new result available.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"error-handling","dir":"Reference","previous_headings":"","what":"Error Handling","title":"Rush Controller — Rush","text":"evaluating tasks distributed system, many things can go wrong. Simple R errors worker loop caught written archive. task marked \"failed\". connection worker lost, looks like task \"running\" forever. methods $detect_lost_workers() $detect_lost_tasks() detect lost workers. Running methods periodically adds small overhead.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"logging","dir":"Reference","previous_headings":"","what":"Logging","title":"Rush Controller — Rush","text":"worker logs messages written lgr package data base. lgr_thresholds argument defines logging level logger e.g. c(rush = \"debug\"). Saving log messages adds small overhead useful debugging. default, log messages stored.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Rush Controller — Rush","text":"network_id (character(1)) Identifier rush network. config (redux::redis_config) Redis configuration options. connector (redux::redis_api) Returns connection Redis. processes (processx::process) List processes started $start_workers().","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Rush Controller — Rush","text":"n_workers (integer(1)) Number workers. n_running_workers (integer(1)) Number running workers. worker_ids (character()) Ids workers. running_worker_ids (character()) Ids running workers. terminated_worker_ids (character()) Ids terminated workers. killed_worker_ids (character()) Ids killed workers. lost_worker_ids (character()) Ids lost workers. tasks (character()) Keys tasks. queued_tasks (character()) Keys queued tasks. running_tasks (character()) Keys running tasks. finished_tasks (character()) Keys finished tasks. failed_tasks (character()) Keys failed tasks. n_queued_tasks (integer(1)) Number queued tasks. n_queued_priority_tasks (integer(1)) Number queued priority tasks. n_running_tasks (integer(1)) Number running tasks. n_finished_tasks (integer(1)) Number finished tasks. n_failed_tasks (integer(1)) Number failed tasks. n_tasks (integer(1)) Number tasks. data (data.table::data.table) Contains performed function calls. worker_info (data.table::data.table()) Contains information workers. worker_states (data.table::data.table()) Contains states workers. priority_info (data.table::data.table) Contains number tasks priority queues. snapshot_schedule (character()) Set snapshot schedule periodically save data base disk. example, c(60, 1000) saves data base every 60 seconds least 1000 changes. Overwrites redis configuration file. Set NULL disable snapshots. details see redis.io.","code":""},{"path":[]},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Rush Controller — Rush","text":"Rush$new() Rush$format() Rush$print() Rush$start_workers() Rush$restart_workers() Rush$create_worker_script() Rush$wait_for_workers() Rush$stop_workers() Rush$detect_lost_workers() Rush$reset() Rush$read_log() Rush$push_tasks() Rush$push_priority_tasks() Rush$fetch_latest_results() Rush$wait_for_latest_results() Rush$fetch_results() Rush$fetch_queued_tasks() Rush$fetch_priority_tasks() Rush$fetch_running_tasks() Rush$fetch_finished_tasks() Rush$wait_for_finished_tasks() Rush$fetch_failed_tasks() Rush$fetch_tasks() Rush$wait_for_tasks() Rush$write_hashes() Rush$read_hashes() Rush$n_tries() Rush$clone()","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Rush Controller — Rush","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$new(network_id = NULL, config = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. config (redux::redis_config) Redis configuration options. NULL, configuration set rush_plan() used. rush_plan() called, REDIS_URL environment variable parsed. REDIS_URL set, default configuration used. See redux::redis_config details.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-format-","dir":"Reference","previous_headings":"","what":"Method format()","title":"Rush Controller — Rush","text":"Helper print outputs.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$format(...)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"... (ignored).","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()).","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Rush Controller — Rush","text":"Print method.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$print()"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-1","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()).","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-start-workers-","dir":"Reference","previous_headings":"","what":"Method start_workers()","title":"Rush Controller — Rush","text":"Start workers locally processx. processx::process stored $processes. Alternatively, use $create_worker_script() create script starting workers remote machines. default, worker_loop_default() used worker loop. function takes arguments fun optionally constants passed ....","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$start_workers(   n_workers = NULL,   wait_for_workers = TRUE,   globals = NULL,   packages = NULL,   heartbeat_period = NULL,   heartbeat_expire = NULL,   lgr_thresholds = NULL,   lgr_buffer_size = 0,   max_retries = 0,   seed = NULL,   supervise = TRUE,   worker_loop = worker_loop_default,   ... )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"n_workers (integer(1)) Number workers started. wait_for_workers (logical(1)) Whether wait workers available. globals (character()) Global variables loaded workers global environment. packages (character()) Packages loaded workers. heartbeat_period (integer(1)) Period heartbeat seconds. heartbeat_expire (integer(1)) Time live heartbeat seconds. lgr_thresholds (named character() | named numeric()) Logger threshold workers e.g. c(rush = \"debug\"). lgr_buffer_size (integer(1)) default (lgr_buffer_size = 0), log messages directly saved Redis data store. lgr_buffer_size > 0, log messages buffered saved Redis data store buffer full. improves performance logging. seed (integer(1)) Seed random number generator. supervise (logical(1)) Whether kill workers main R process shut . worker_loop (function) Loop run workers. Defaults worker_loop_default called fun. Pass fun .... ... () Arguments passed worker_loop.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-restart-workers-","dir":"Reference","previous_headings":"","what":"Method restart_workers()","title":"Rush Controller — Rush","text":"Restart workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$restart_workers(worker_ids)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"worker_ids (character()) Worker ids restarted.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-create-worker-script-","dir":"Reference","previous_headings":"","what":"Method create_worker_script()","title":"Rush Controller — Rush","text":"Create script start workers. worker started start_worker().","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$create_worker_script(   globals = NULL,   packages = NULL,   heartbeat_period = NULL,   heartbeat_expire = NULL,   lgr_thresholds = NULL,   lgr_buffer_size = 0,   worker_loop = worker_loop_default,   ... )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"globals (character()) Global variables loaded workers global environment. packages (character()) Packages loaded workers. heartbeat_period (integer(1)) Period heartbeat seconds. heartbeat_expire (integer(1)) Time live heartbeat seconds. lgr_thresholds (named character() | named numeric()) Logger threshold workers e.g. c(rush = \"debug\"). lgr_buffer_size (integer(1)) default (lgr_buffer_size = 0), log messages directly saved Redis data store. lgr_buffer_size > 0, log messages buffered saved Redis data store buffer full. improves performance logging. worker_loop (function) Loop run workers. Defaults worker_loop_default called fun. Pass fun .... ... () Arguments passed worker_loop.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-wait-for-workers-","dir":"Reference","previous_headings":"","what":"Method wait_for_workers()","title":"Rush Controller — Rush","text":"Wait n workers available.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$wait_for_workers(n)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"n (integer(1)) Number workers wait .","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-stop-workers-","dir":"Reference","previous_headings":"","what":"Method stop_workers()","title":"Rush Controller — Rush","text":"Stop workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$stop_workers(type = \"terminate\", worker_ids = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"type (character(1)) Type stopping. Either \"terminate\" \"kill\". \"terminate\" workers evaluate currently running task terminate. \"kill\" workers stopped immediately. worker_ids (character()) Worker ids stopped. NULL workers stopped.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-detect-lost-workers-","dir":"Reference","previous_headings":"","what":"Method detect_lost_workers()","title":"Rush Controller — Rush","text":"Detect lost workers. state worker changed \"lost\". Local workers without heartbeat checked process id. Checking local workers unix systems takes microseconds per worker. checking local workers windows might slow. Workers heartbeat process checked heartbeat. Lost tasks marked \"lost\".","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$detect_lost_workers(restart_workers = FALSE, restart_tasks = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"restart_workers (logical(1)) Whether restart lost workers.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-reset-","dir":"Reference","previous_headings":"","what":"Method reset()","title":"Rush Controller — Rush","text":"Stop workers delete data stored redis.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$reset(type = \"kill\")"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"type (character(1)) Type stopping. Either \"terminate\" \"kill\". \"terminate\" workers evaluate currently running task terminate. \"kill\" workers stopped immediately.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-read-log-","dir":"Reference","previous_headings":"","what":"Method read_log()","title":"Rush Controller — Rush","text":"Read log messages written lgr package worker.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$read_log(worker_ids = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"worker_ids (character(1)) Worker ids. NULL worker ids used.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-push-tasks-","dir":"Reference","previous_headings":"","what":"Method push_tasks()","title":"Rush Controller — Rush","text":"Pushes task queue. Task added queued tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$push_tasks(xss, extra = NULL, terminate_workers = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-10","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"xss (list named list()) Lists arguments function e.g. list(list(x1, x2), list(x1, x2))). extra (list) List additional information stored along task e.g. list(list(timestamp), list(timestamp))). terminate_workers (logical(1)) Whether stop workers evaluating tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-2","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()) Keys tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-push-priority-tasks-","dir":"Reference","previous_headings":"","what":"Method push_priority_tasks()","title":"Rush Controller — Rush","text":"Pushes task queue specific worker. Task added queued priority tasks. worker evaluates tasks priority queue shared queue. priority NA task added shared queue. worker lost worker id known, task added shared queue.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$push_priority_tasks(xss, extra = NULL, priority = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-11","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"xss (list named list()) Lists arguments function e.g. list(list(x1, x2), list(x1, x2))). extra (list) List additional information stored along task e.g. list(list(timestamp), list(timestamp))). priority (character()) Worker ids tasks pushed.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-3","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()) Keys tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-latest-results-","dir":"Reference","previous_headings":"","what":"Method fetch_latest_results()","title":"Rush Controller — Rush","text":"Fetch latest results data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_latest_results(fields = \"ys\", data_format = \"data.table\")"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-12","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-4","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Latest results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-wait-for-latest-results-","dir":"Reference","previous_headings":"","what":"Method wait_for_latest_results()","title":"Rush Controller — Rush","text":"Block process new result available. Returns latest results NULL result available timeout seconds.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$wait_for_latest_results(   fields = \"ys\",   timeout = Inf,   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-13","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. timeout (numeric(1)) Time wait result seconds. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-5","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Latest results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-results-","dir":"Reference","previous_headings":"","what":"Method fetch_results()","title":"Rush Controller — Rush","text":"Fetch results data base. Results cached.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_results(   fields = \"ys\",   reset_cache = FALSE,   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-14","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults \"ys\". reset_cache (logical(1)) Whether reset cache. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-6","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-queued-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_queued_tasks()","title":"Rush Controller — Rush","text":"Fetch queued tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-16","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_queued_tasks(   fields = c(\"xs\", \"xs_extra\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-15","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\"). data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-7","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table queued tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-priority-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_priority_tasks()","title":"Rush Controller — Rush","text":"Fetch queued priority tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-17","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_priority_tasks(   fields = c(\"xs\", \"xs_extra\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-16","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\"). data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-8","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table queued priority tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-running-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_running_tasks()","title":"Rush Controller — Rush","text":"Fetch running tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-18","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_running_tasks(   fields = c(\"xs\", \"xs_extra\", \"worker_extra\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-17","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\"). data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-9","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table running tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-finished-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_finished_tasks()","title":"Rush Controller — Rush","text":"Fetch finished tasks data base. Finished tasks cached.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-19","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_finished_tasks(   fields = c(\"xs\", \"ys\", \"xs_extra\", \"worker_extra\", \"ys_extra\"),   reset_cache = FALSE,   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-18","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\", \"ys\", \"ys_extra\"). reset_cache (logical(1)) Whether reset cache. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-10","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table finished tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-wait-for-finished-tasks-","dir":"Reference","previous_headings":"","what":"Method wait_for_finished_tasks()","title":"Rush Controller — Rush","text":"Block process new finished task available. Returns finished tasks NULL new task available timeout seconds.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-20","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$wait_for_finished_tasks(   fields = c(\"xs\", \"ys\", \"xs_extra\", \"worker_extra\", \"ys_extra\"),   timeout = Inf,   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-19","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\", \"ys\", \"ys_extra\"). timeout (numeric(1)) Time wait result seconds. data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-11","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table finished tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-failed-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_failed_tasks()","title":"Rush Controller — Rush","text":"Fetch failed tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-21","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_failed_tasks(   fields = c(\"xs\", \"worker_extra\", \"condition\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-20","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\", \"condition\". data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-12","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table failed tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-fetch-tasks-","dir":"Reference","previous_headings":"","what":"Method fetch_tasks()","title":"Rush Controller — Rush","text":"Fetch tasks data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-22","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$fetch_tasks(   fields = c(\"xs\", \"ys\", \"xs_extra\", \"worker_extra\", \"ys_extra\", \"condition\", \"state\"),   data_format = \"data.table\" )"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-21","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"fields (character()) Fields read hashes. Defaults c(\"xs\", \"xs_extra\", \"worker_extra\", \"ys\", \"ys_extra\", \"condition\", \"state\"). data_format (character()) Returned data format. Choose \"data.table\" \"list\". default \"data.table\" \"list\" easier list columns present.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-13","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"data.table() Table tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-wait-for-tasks-","dir":"Reference","previous_headings":"","what":"Method wait_for_tasks()","title":"Rush Controller — Rush","text":"Wait tasks finished. function also unblocks worker running tasks failed.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-23","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$wait_for_tasks(keys, detect_lost_workers = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-22","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"keys (character()) Keys tasks wait . detect_lost_workers (logical(1)) Whether detect failed tasks. Comes overhead.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-write-hashes-","dir":"Reference","previous_headings":"","what":"Method write_hashes()","title":"Rush Controller — Rush","text":"Writes list redis hashes. function serializes element writes new hash. name argument defines field serialized element written. example, xs = list(list(x1 = 1, x2 = 2), list(x1 = 3, x2 = 4)) writes serialize(list(x1 = 1, x2 = 2)) field xs hash serialize(list(x1 = 3, x2 = 4)) field xs another hash. function can iterate multiple lists simultaneously. example, xs = list(list(x1 = 1, x2 = 2), list(x1 = 3, x2 = 4)), ys = list(list(y = 3), list(y = 7)) creates two hashes fields xs ys. Different lengths recycled. stored elements must lists . reading functions combine hashes table names inner lists column names. example, xs = list(list(x1 = 1, x2 = 2), list(x1 = 3, x2 = 4)), ys = list(list(y = 3), list(y = 7)) becomes data.table(x1 = c(1, 3), x2 = c(2, 4), y = c(3, 7)). Vectors list columns must wrapped lists. Otherwise, $read_values() expand table length vectors. example, xs = list(list(x1 = 1, x2 = 2)), xs_extra = list(list(extra = c(\"\", \"B\", \"C\"))) work. Pass xs_extra = list(list(extra = list(c(\"\", \"B\", \"C\"))))` instead.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-24","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$write_hashes(..., .values = list(), keys = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-23","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"... (named list()) Lists written hashes. names arguments used fields. .values (named list()) Lists written hashes. names list used fields. keys (character()) Keys hashes. NULL new keys generated.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-14","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(character()) Keys hashes.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-read-hashes-","dir":"Reference","previous_headings":"","what":"Method read_hashes()","title":"Rush Controller — Rush","text":"Reads redis hashes written $write_hashes(). function reads values fields hashes stored keys. values hash deserialized combined single list.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-25","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$read_hashes(keys, fields)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-24","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"keys (character()) Keys hashes. fields (character()) Fields read hashes.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-15","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(list list()) outer list contains one element key. inner list combination lists stored different fields.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-n-tries-","dir":"Reference","previous_headings":"","what":"Method n_tries()","title":"Rush Controller — Rush","text":"Returns number attempts evaluate task.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-26","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$n_tries(keys)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-25","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"keys (character()) Keys tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"returns-16","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Controller — Rush","text":"(integer()) Number attempts.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Rush Controller — Rush","text":"objects class cloneable method.","code":""},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"usage-27","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Controller — Rush","text":"","code":"Rush$clone(deep = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/Rush.html","id":"arguments-26","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Controller — Rush","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":null,"dir":"Reference","previous_headings":"","what":"Rush Worker — RushWorker","title":"Rush Worker — RushWorker","text":"RushWorker evaluates tasks writes results data base. worker inherits Rush.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Rush Worker — RushWorker","text":"worker registers data base rush network.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Rush Worker — RushWorker","text":"rush::Rush -> RushWorker","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Rush Worker — RushWorker","text":"worker_id (character(1)) Identifier worker. host (character(1)) Worker started local remote host. heartbeat (`r_process``) Background process heartbeat.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Rush Worker — RushWorker","text":"terminated (logical(1)) Whether shutdown worker. Used worker loop determine whether continue. terminated_on_idle (logical(1)) Whether shutdown worker tasks queued. Used worker loop determine whether continue.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Rush Worker — RushWorker","text":"rush::Rush$create_worker_script() rush::Rush$detect_lost_workers() rush::Rush$fetch_failed_tasks() rush::Rush$fetch_finished_tasks() rush::Rush$fetch_latest_results() rush::Rush$fetch_priority_tasks() rush::Rush$fetch_queued_tasks() rush::Rush$fetch_results() rush::Rush$fetch_running_tasks() rush::Rush$fetch_tasks() rush::Rush$format() rush::Rush$n_tries() rush::Rush$print() rush::Rush$push_priority_tasks() rush::Rush$push_tasks() rush::Rush$read_hashes() rush::Rush$read_log() rush::Rush$reset() rush::Rush$restart_workers() rush::Rush$start_workers() rush::Rush$stop_workers() rush::Rush$wait_for_finished_tasks() rush::Rush$wait_for_latest_results() rush::Rush$wait_for_tasks() rush::Rush$wait_for_workers() rush::Rush$write_hashes()","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Rush Worker — RushWorker","text":"RushWorker$new() RushWorker$push_running_task() RushWorker$pop_task() RushWorker$push_results() RushWorker$push_failed() RushWorker$set_seed() RushWorker$set_terminated() RushWorker$clone()","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Rush Worker — RushWorker","text":"Creates new instance R6 class.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$new(   network_id,   config = NULL,   host,   worker_id = NULL,   heartbeat_period = NULL,   heartbeat_expire = NULL,   lgr_thresholds = NULL,   lgr_buffer_size = 0,   seed = NULL,   max_retries = 0 )"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. config (redux::redis_config) Redis configuration options. NULL, configuration set rush_plan() used. rush_plan() called, REDIS_URL environment variable parsed. REDIS_URL set, default configuration used. See redux::redis_config details. host (character(1)) Worker started local remote host. See Rush details. worker_id (character(1)) Identifier worker. Keys redis specific worker prefixed worker id. heartbeat_period (integer(1)) Period heartbeat seconds. heartbeat_expire (integer(1)) Time live heartbeat seconds. lgr_thresholds (named character() | named numeric()) Logger threshold workers e.g. c(rush = \"debug\"). lgr_buffer_size (integer(1)) default (lgr_buffer_size = 0), log messages directly saved Redis data store. lgr_buffer_size > 0, log messages buffered saved Redis data store buffer full. improves performance logging. seed (integer(1)) Seed random number generator.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-push-running-task-","dir":"Reference","previous_headings":"","what":"Method push_running_task()","title":"Rush Worker — RushWorker","text":"Push task running tasks without queue.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$push_running_task(xss, extra = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"xss (list named list()) Lists arguments function e.g. list(list(x1, x2), list(x1, x2))). extra (list) List additional information stored along task e.g. list(list(timestamp), list(timestamp))).","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"returns","dir":"Reference","previous_headings":"","what":"Returns","title":"Rush Worker — RushWorker","text":"(character()) Keys tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-pop-task-","dir":"Reference","previous_headings":"","what":"Method pop_task()","title":"Rush Worker — RushWorker","text":"Pop task queue. Task moved running tasks.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$pop_task(timeout = 1)"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"timeout (numeric(1)) Time wait task seconds.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-push-results-","dir":"Reference","previous_headings":"","what":"Method push_results()","title":"Rush Worker — RushWorker","text":"Pushes results data base.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$push_results(   keys,   yss = list(),   extra = list(),   conditions = list() )"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"keys (character(1)) Keys associated tasks. yss (named list()) List lists named results. extra (named list()) List lists additional information stored along results. conditions (named list()) List lists conditions. state (character(1)) Status tasks. \"finished\" tasks moved finished tasks. \"error\" tasks moved failed tasks.","code":""},{"path":[]},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$push_failed(keys, conditions)"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-set-seed-","dir":"Reference","previous_headings":"","what":"Method set_seed()","title":"Rush Worker — RushWorker","text":"Sets seed key. Updates seed table necessary.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$set_seed(key)"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"key (character(1)) Key task.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-set-terminated-","dir":"Reference","previous_headings":"","what":"Method set_terminated()","title":"Rush Worker — RushWorker","text":"Mark worker terminated. Last step worker loop worker terminates.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$set_terminated()"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Rush Worker — RushWorker","text":"objects class cloneable method.","code":""},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Worker — RushWorker","text":"","code":"RushWorker$clone(deep = FALSE)"},{"path":"https://mlr3.mlr-org.com/reference/RushWorker.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rush Worker — RushWorker","text":"deep Whether make deep clone.","code":""},{"path":"https://mlr3.mlr-org.com/reference/get_hostname.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the computer name of the current host — get_hostname","title":"Get the computer name of the current host — get_hostname","text":"Returns computer name current host. First tries get computer name environment variables HOST, HOSTNAME COMPUTERNAME. fails tries get computer name function Sys.info(). Finally, fails queries computer name command uname -n. Copied R.utils package.","code":""},{"path":"https://mlr3.mlr-org.com/reference/get_hostname.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the computer name of the current host — get_hostname","text":"","code":"get_hostname()"},{"path":"https://mlr3.mlr-org.com/reference/heartbeat.html","id":null,"dir":"Reference","previous_headings":"","what":"Heartbeat Loop — heartbeat","title":"Heartbeat Loop — heartbeat","text":"heartbeat loop updates heartbeat key worker still alive. kill key set, worker killed.","code":""},{"path":"https://mlr3.mlr-org.com/reference/heartbeat.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Heartbeat Loop — heartbeat","text":"","code":"heartbeat(   network_id,   config,   worker_id,   heartbeat_period,   heartbeat_expire,   pid )"},{"path":"https://mlr3.mlr-org.com/reference/heartbeat.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Heartbeat Loop — heartbeat","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. config (redux::redis_config) Redis configuration options. worker_id (character(1)) Identifier worker. Keys redis specific worker prefixed worker id. heartbeat_period (integer(1)) Period heartbeat seconds. heartbeat_expire (integer(1)) Time live heartbeat seconds. pid (integer(1)) Process ID worker.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rsh.html","id":null,"dir":"Reference","previous_headings":"","what":"Synctatic Sugar for Rush Controller Construction — rsh","title":"Synctatic Sugar for Rush Controller Construction — rsh","text":"Function construct Rush controller.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rsh.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Synctatic Sugar for Rush Controller Construction — rsh","text":"","code":"rsh(network_id = NULL, config = NULL, ...)"},{"path":"https://mlr3.mlr-org.com/reference/rsh.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Synctatic Sugar for Rush Controller Construction — rsh","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. config (redux::redis_config) Redis configuration options. NULL, configuration set rush_plan() used. rush_plan() called, REDIS_URL environment variable parsed. REDIS_URL set, default configuration used. See redux::redis_config details. ... (ignored).","code":""},{"path":"https://mlr3.mlr-org.com/reference/rsh.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Synctatic Sugar for Rush Controller Construction — rsh","text":"","code":"rsh(network_id = \"benchmark\") #> Error in initialize(...): Can't connect to Redis. Check the configuration."},{"path":"https://mlr3.mlr-org.com/reference/rush-package.html","id":null,"dir":"Reference","previous_headings":"","what":"rush: Parallel and Distributed Programming — rush-package","title":"rush: Parallel and Distributed Programming — rush-package","text":"Parallel programming package.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"rush: Parallel and Distributed Programming — rush-package","text":"Maintainer: Marc Becker marcbecker@posteo.de (ORCID)","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_available.html","id":null,"dir":"Reference","previous_headings":"","what":"Rush Available — rush_available","title":"Rush Available — rush_available","text":"Returns TRUE redis config file (redux::redis_config) set rush_plan().","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_available.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rush Available — rush_available","text":"","code":"rush_available()"},{"path":"https://mlr3.mlr-org.com/reference/rush_available.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rush Available — rush_available","text":"logical(1)","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_config.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Rush Config — rush_config","title":"Get Rush Config — rush_config","text":"Returns redis config file (redux::redis_config) set rush_plan().","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Rush Config — rush_config","text":"","code":"rush_config()"},{"path":"https://mlr3.mlr-org.com/reference/rush_config.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Rush Config — rush_config","text":"redux::redis_config() redis config file.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_plan.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Rush Plan — rush_plan","title":"Create Rush Plan — rush_plan","text":"Stores number workers Redis configuration options (redux::redis_config) Rush. function tests connection Redis throws error connection fails.","code":""},{"path":"https://mlr3.mlr-org.com/reference/rush_plan.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Rush Plan — rush_plan","text":"","code":"rush_plan(n_workers, config = NULL)"},{"path":"https://mlr3.mlr-org.com/reference/rush_plan.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Rush Plan — rush_plan","text":"n_workers (integer(1)) Number workers started. config (redux::redis_config) Configuration options used connect Redis. NULL, REDIS_URL environment variable parsed. REDIS_URL set, default configuration used. See redux::redis_config details.","code":""},{"path":"https://mlr3.mlr-org.com/reference/start_worker.html","id":null,"dir":"Reference","previous_headings":"","what":"Start a worker — start_worker","title":"Start a worker — start_worker","text":"Starts worker. function loads globals packages, initializes RushWorker instance invokes worker loop. function called $start_workers() user creating worker script $create_worker_script().","code":""},{"path":"https://mlr3.mlr-org.com/reference/start_worker.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Start a worker — start_worker","text":"","code":"start_worker(network_id, worker_id = NULL, hostname, ...)"},{"path":"https://mlr3.mlr-org.com/reference/start_worker.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Start a worker — start_worker","text":"network_id (character(1)) Identifier rush network. Controller workers must instance id. Keys Redis prefixed instance id. worker_id (character(1)) Identifier worker. Keys redis specific worker prefixed worker id. hostname (character(1)) Hostname rush controller instance. Used determine worker started local remote host. ... () Arguments passed redux::redis_config.","code":""},{"path":"https://mlr3.mlr-org.com/reference/start_worker.html","id":"note","dir":"Reference","previous_headings":"","what":"Note","title":"Start a worker — start_worker","text":"function initializes connection Redis data base. loads packages copies globals global environment worker. function initialize RushWorker instance starts worker loop.","code":""},{"path":"https://mlr3.mlr-org.com/reference/worker_loop_default.html","id":null,"dir":"Reference","previous_headings":"","what":"Single Task Worker Loop — worker_loop_default","title":"Single Task Worker Loop — worker_loop_default","text":"Worker loop pops single task queue, executes function pushes results.","code":""},{"path":"https://mlr3.mlr-org.com/reference/worker_loop_default.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Single Task Worker Loop — worker_loop_default","text":"","code":"worker_loop_default(fun, constants = NULL, rush)"},{"path":"https://mlr3.mlr-org.com/reference/worker_loop_default.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Single Task Worker Loop — worker_loop_default","text":"fun (function) Function executed. constants (list) List constants passed fun. rush (RushWorker) Rush worker instance.","code":""}]