mirai - Parallel Integration

Parallel Integration

mirai provides an alternative communications backend for R. This functionality was developed to fulfil a request by R Core at R Project Sprint 2023.

make_cluster() creates a cluster object of class 'miraiCluster', which is fully-compatible with parallel cluster types. From R 4.5 onwards, mirai is recognised as one of the official cluster types and can also be created by parallel::makeCluster(type = "MIRAI").

Created clusters may be used for any function in the parallel base package such as parallel::clusterApply() or parallel::parLapply(), or the load-balanced versions such as parallel::parLapplyLB().

library(mirai)

cl <- make_cluster(4)
cl
#> < miraiCluster | ID: `0` nodes: 4 active: TRUE >
parallel::parLapply(cl, iris, mean)
#> $Sepal.Length
#> [1] 5.843333
#> 
#> $Sepal.Width
#> [1] 3.057333
#> 
#> $Petal.Length
#> [1] 3.758
#> 
#> $Petal.Width
#> [1] 1.199333
#> 
#> $Species
#> [1] NA

status() may be called on a 'miraiCluster` to query the number of connected nodes at any time.

status(cl)
#> $connections
#> [1] 4
#> 
#> $daemons
#> [1] "abstract://c54f0592af1ba381bcfbde74"
stop_cluster(cl)

Making a cluster specifying 'url' without 'remote' causes the shell commands for manual deployment of nodes to be printed to the console.

cl <- make_cluster(n = 2, url = host_url())
#> Shell commands for deployment on nodes:
#> 
#> [1]
#> Rscript -e 'mirai::daemon("tcp://hostname:44599",dispatcher=FALSE,cleanup=FALSE,rs=c(10407,-1275635401,97598476,-2069515875,1414607802,-664740365,248124056))'
#> 
#> [2]
#> Rscript -e 'mirai::daemon("tcp://hostname:44599",dispatcher=FALSE,cleanup=FALSE,rs=c(10407,-1197809085,136434206,-501206156,1499687871,-1941970059,-2049706599))'
stop_cluster(cl)

Foreach Integration

A 'miraiCluster' may also be registered by doParallel for use with the foreach package.

Running some parallel examples for the foreach() function:

library(foreach)
library(iterators)

cl <- make_cluster(4)
doParallel::registerDoParallel(cl)

# normalize the rows of a matrix
m <- matrix(rnorm(9), 3, 3)
foreach(i = 1:nrow(m), .combine = rbind) %dopar%
  (m[i, ] / mean(m[i, ]))
#>                [,1]       [,2]       [,3]
#> result.1  1.9419991  2.9336232 -1.8756223
#> result.2 -0.4692218  3.1719796  0.2972422
#> result.3 -0.8612108 -0.8675435  4.7287543
# simple parallel matrix multiply
a <- matrix(1:16, 4, 4)
b <- t(a)
foreach(b = iter(b, by='col'), .combine = cbind) %dopar%
  (a %*% b)
#>      [,1] [,2] [,3] [,4]
#> [1,]  276  304  332  360
#> [2,]  304  336  368  400
#> [3,]  332  368  404  440
#> [4,]  360  400  440  480


Try the mirai package in your browser

Any scripts or data that you put into this service are public.

mirai documentation built on April 4, 2025, 12:27 a.m.