Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Feb 8, 2024
1 parent 65289f5 commit a562e97
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 34 deletions.
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Description: Fast parallel code execution and distributed computing. Designed
for simplicity, a 'mirai' evaluates an R expression asynchronously, on local
or network resources, resolving automatically upon completion. Efficient and
reliable scheduling over fast inter-process communications or secure TLS
connections over TCP/IP, built on 'nanonext' and 'NNG' (Nanomsg Next Gen).
connections over TCP/IP, built on 'nanonext' and 'NNG' (Nanomsg Next Gen)
technology.
Authors@R:
c(person(given = "Charlie",
family = "Gao",
Expand Down
2 changes: 1 addition & 1 deletion R/mirai-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
#' or network resources, resolving automatically upon completion. Efficient
#' and reliable scheduling over fast inter-process communications or secure
#' TLS connections over TCP/IP, built on 'nanonext' and 'NNG' (Nanomsg Next
#' Gen).
#' Gen) technology.
#'
#' @section Notes:
#'
Expand Down
18 changes: 8 additions & 10 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,17 @@ knitr::opts_chunk$set(
[![DOI](https://zenodo.org/badge/459341940.svg)](https://zenodo.org/badge/latestdoi/459341940)
<!-- badges: end -->

#### みらい
### みらい
<br />

##### Minimalist. Futuristic. Reliable.
<br />
Minimalist async evaluation framework for R. Fast parallel code execution and distributed computing.
Minimalist ・ Futuristic ・ Reliable
<br /><br />
`mirai()` returns a 'mirai' object immediately. Designed for simplicity, a 'mirai' evaluates an R expression asynchronously, on local or network resources, resolving automatically upon completion.
Async evaluation framework for R.
<br /><br />
Efficient scheduling over fast inter-process communications or secure TLS connections over TCP/IP, built on 'nanonext' and 'NNG' (Nanomsg Next Gen).
Fast parallel code execution and distributed computing.
<br /><br />
{mirai} has a tiny pure R code base, relying solely on [`nanonext`](https://doi.org/10.5281/zenodo.7903429), a high-performance binding for the 'NNG' (Nanomsg Next Gen) C library with zero package dependencies.
`mirai()` returns a 'mirai' object immediately. Designed for simplicity, a 'mirai' evaluates an R expression asynchronously, on local or network resources, resolving automatically upon completion.
<br /><br />
Efficient scheduling over fast inter-process communications or secure TLS connections over TCP/IP, built on [nanonext](https://doi.org/10.5281/zenodo.7903429) and [NNG](https://nng.nanomsg.org/) technology.

### Installation

Expand Down Expand Up @@ -107,9 +105,9 @@ Daemons are persistent background processes created to receive 'mirai' requests.

They may be deployed for:

[local](https://shikokuchuo.net/mirai/articles/mirai.html#daemons-local-persistent-processes) parallel processing, or
[Local](https://shikokuchuo.net/mirai/articles/mirai.html#daemons-local-persistent-processes) parallel processing; or

[remote](https://shikokuchuo.net/mirai/articles/mirai.html#distributed-computing-remote-daemons) network distributed computing.
[Remote](https://shikokuchuo.net/mirai/articles/mirai.html#distributed-computing-remote-daemons) network distributed computing.

[Launchers](https://shikokuchuo.net/mirai/articles/mirai.html#distributed-computing-launching-daemons) allow daemons to be started both on the local machine and across the network via SSH etc.

Expand Down
36 changes: 15 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,17 @@ badge](https://shikokuchuo.r-universe.dev/badges/mirai?color=24a60e)](https://sh
[![DOI](https://zenodo.org/badge/459341940.svg)](https://zenodo.org/badge/latestdoi/459341940)
<!-- badges: end -->

#### みらい
### みらい

<br />

##### Minimalist. Futuristic. Reliable.

<br /> Minimalist async evaluation framework for R. Fast parallel code
execution and distributed computing. <br /><br /> `mirai()` returns a
‘mirai’ object immediately. Designed for simplicity, a ‘mirai’ evaluates
an R expression asynchronously, on local or network resources, resolving
<br /> Minimalist ・ Futuristic ・ Reliable <br /><br /> Async
evaluation framework for R. <br /><br /> Fast parallel code execution
and distributed computing. <br /><br /> `mirai()` returns a ‘mirai’
object immediately. Designed for simplicity, a ‘mirai’ evaluates an R
expression asynchronously, on local or network resources, resolving
automatically upon completion. <br /><br /> Efficient scheduling over
fast inter-process communications or secure TLS connections over TCP/IP,
built on ‘nanonext’ and ‘NNG’ (Nanomsg Next Gen). <br /><br /> {mirai}
has a tiny pure R code base, relying solely on
[`nanonext`](https://doi.org/10.5281/zenodo.7903429), a high-performance
binding for the ‘NNG’ (Nanomsg Next Gen) C library with zero package
dependencies. <br /><br />
built on [nanonext](https://doi.org/10.5281/zenodo.7903429) and
[NNG](https://nng.nanomsg.org/) technology.

### Installation

Expand Down Expand Up @@ -92,17 +86,17 @@ result.

``` r
m$data
#> [1] -0.08295478 1.22776260 -0.36085405 -3.75600305 3.46431923
#> [6] 0.28865700 -0.26624047 -2.77120347 0.81448971 -12.05475992
#> [1] 0.13054418 -2.02865586 -1.01018934 0.22447429 -27.03949620
#> [6] -0.03698294 4.45485315 -0.98991344 -0.49293723 7.66024205
```

Alternatively, explicitly call and wait for the result using
`call_mirai()`.

``` r
call_mirai(m)$data
#> [1] -0.08295478 1.22776260 -0.36085405 -3.75600305 3.46431923
#> [6] 0.28865700 -0.26624047 -2.77120347 0.81448971 -12.05475992
#> [1] 0.13054418 -2.02865586 -1.01018934 0.22447429 -27.03949620
#> [6] -0.03698294 4.45485315 -0.98991344 -0.49293723 7.66024205
```

### Daemons
Expand All @@ -112,10 +106,10 @@ requests.

They may be deployed for:

[local](https://shikokuchuo.net/mirai/articles/mirai.html#daemons-local-persistent-processes)
parallel processing, or
[Local](https://shikokuchuo.net/mirai/articles/mirai.html#daemons-local-persistent-processes)
parallel processing; or

[remote](https://shikokuchuo.net/mirai/articles/mirai.html#distributed-computing-remote-daemons)
[Remote](https://shikokuchuo.net/mirai/articles/mirai.html#distributed-computing-remote-daemons)
network distributed computing.

[Launchers](https://shikokuchuo.net/mirai/articles/mirai.html#distributed-computing-launching-daemons)
Expand Down
2 changes: 1 addition & 1 deletion man/mirai-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a562e97

Please sign in to comment.