Skip to content

Commit 70930fa

Browse files
committed
Refresh readme
1 parent 25d112a commit 70930fa

File tree

2 files changed

+43
-42
lines changed

2 files changed

+43
-42
lines changed

README.Rmd

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ install.packages("mirai")
5151

5252
### Quick Start
5353

54-
`mirai()`: Evaluate an R expression asynchronously in a parallel process.
54+
- `mirai()`: Evaluate an R expression asynchronously in a parallel process.
5555

56-
`daemons()`: Set and launch persistent background processes, local or remote, on which to run mirai tasks.
56+
- `daemons()`: Set and launch persistent background processes, local or remote, on which to run mirai tasks.
5757

5858
```{r}
5959
#| label: exec
@@ -79,6 +79,20 @@ mp[.flat]
7979
daemons(0)
8080
```
8181

82+
### Key Features
83+
84+
1. Distributed Execution: Run tasks across networks and clusters using various deployment methods (SSH, HPC clusters using Slurm, SGE, Torque, PBS, LSF, etc.)
85+
86+
1. Compute Profiles: Manage different sets of daemons independently, allowing tasks with different requirements to be executed on appropriate resources.
87+
88+
1. Promises Integration: An event-driven implementation performs actions on returned values as soon as tasks complete, with minimal latency.
89+
90+
1. Serialization Support: Native serialization support for reference objects such as Arrow Tables, Polars DataFrames or torch tensors.
91+
92+
1. Error Handling: Robust error handling and reporting, with full stack traces for debugging.
93+
94+
1. RNG Management: L'Ecuyer-CMRG RNG streams for reproducible parallel random number generation.
95+
8296
### Design Concepts
8397

8498
mirai is designed from the ground up to provide a production-grade experience.
@@ -103,20 +117,6 @@ mirai is designed from the ground up to provide a production-grade experience.
103117
- Capacity for millions of tasks over thousands of connections
104118
- Proven track record for heavy-duty workloads in the life sciences industry
105119

106-
### Key Features
107-
108-
→ Distributed Execution: Run tasks across networks and clusters using various deployment methods (SSH, HPC clusters using Slurm, SGE, Torque, PBS, LSF, etc.)
109-
110-
→ Compute Profiles: Manage different sets of daemons independently, allowing tasks with different requirements to be executed on appropriate resources.
111-
112-
→ Promises Integration: An event-driven implementation performs actions on returned values as soon as tasks complete, ensuring minimal latency.
113-
114-
→ Serialization Support: Native serialization support for reference objects such as Arrow Tables, Polars DataFrames or torch tensors.
115-
116-
→ Error Handling: Robust error handling and reporting, with full stack traces for debugging.
117-
118-
→ RNG Management: L'Ecuyer-CMRG RNG streams for reproducible parallel random number generation.
119-
120120
### Powering the Ecosystem
121121

122122
mirai serves as a foundation for asynchronous and parallel computing in the R ecosystem:

README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ install.packages("mirai")
3939

4040
### Quick Start
4141

42-
`mirai()`: Evaluate an R expression asynchronously in a parallel
43-
process.
42+
- `mirai()`: Evaluate an R expression asynchronously in a parallel
43+
process.
4444

45-
`daemons()`: Set and launch persistent background processes, local or
46-
remote, on which to run mirai tasks.
45+
- `daemons()`: Set and launch persistent background processes, local or
46+
remote, on which to run mirai tasks.
4747

4848
``` r
4949
library(mirai)
@@ -72,6 +72,29 @@ mp[.flat]
7272
daemons(0)
7373
```
7474

75+
### Key Features
76+
77+
1. Distributed Execution: Run tasks across networks and clusters using
78+
various deployment methods (SSH, HPC clusters using Slurm, SGE,
79+
Torque, PBS, LSF, etc.)
80+
81+
2. Compute Profiles: Manage different sets of daemons independently,
82+
allowing tasks with different requirements to be executed on
83+
appropriate resources.
84+
85+
3. Promises Integration: An event-driven implementation performs
86+
actions on returned values as soon as tasks complete, with minimal
87+
latency.
88+
89+
4. Serialization Support: Native serialization support for reference
90+
objects such as Arrow Tables, Polars DataFrames or torch tensors.
91+
92+
5. Error Handling: Robust error handling and reporting, with full stack
93+
traces for debugging.
94+
95+
6. RNG Management: L’Ecuyer-CMRG RNG streams for reproducible parallel
96+
random number generation.
97+
7598
### Design Concepts
7699

77100
mirai is designed from the ground up to provide a production-grade
@@ -103,28 +126,6 @@ experience.
103126
- Proven track record for heavy-duty workloads in the life sciences
104127
industry
105128

106-
### Key Features
107-
108-
→ Distributed Execution: Run tasks across networks and clusters using
109-
various deployment methods (SSH, HPC clusters using Slurm, SGE, Torque,
110-
PBS, LSF, etc.)
111-
112-
→ Compute Profiles: Manage different sets of daemons independently,
113-
allowing tasks with different requirements to be executed on appropriate
114-
resources.
115-
116-
→ Promises Integration: An event-driven implementation performs actions
117-
on returned values as soon as tasks complete, ensuring minimal latency.
118-
119-
→ Serialization Support: Native serialization support for reference
120-
objects such as Arrow Tables, Polars DataFrames or torch tensors.
121-
122-
→ Error Handling: Robust error handling and reporting, with full stack
123-
traces for debugging.
124-
125-
→ RNG Management: L’Ecuyer-CMRG RNG streams for reproducible parallel
126-
random number generation.
127-
128129
### Powering the Ecosystem
129130

130131
mirai serves as a foundation for asynchronous and parallel computing in

0 commit comments

Comments
 (0)