Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Dec 28, 2023
1 parent adbd0b7 commit 40b45fe
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 24 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: mirai
Type: Package
Title: Minimalist Async Evaluation Framework for R
Version: 0.11.3.9000
Version: 0.11.3.9001
Description: Lightweight 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.
Expand All @@ -22,7 +22,7 @@ Encoding: UTF-8
Depends:
R (>= 3.5)
Imports:
nanonext (>= 0.11.0.9000)
nanonext (>= 0.11.0.9001)
Enhances:
parallel,
promises
Expand Down
5 changes: 3 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# mirai 0.11.3.9000 (development)
# mirai 0.11.3.9001 (development)

* `daemon()` argument 'autoexit' now accepts a signal value such as `tools::SIGINT` in order to raise it upon exit.
* Requires nanonext >= [0.11.0.9000].
* Eliminates potential memory leaks along certain error paths.
* Requires nanonext >= [0.11.0.9001].

# mirai 0.11.3

Expand Down
23 changes: 12 additions & 11 deletions R/daemons.R
Original file line number Diff line number Diff line change
Expand Up @@ -420,17 +420,18 @@ status <- function(.compute = "default") {
#' Registers custom serialization and unserialization functions for sending and
#' receiving external pointer reference objects.
#'
#' @param refhook \strong{either} a list of two functions: the signature for the
#' first must accept a list of external pointer type objects and return a
#' raw vector, e.g. \code{torch::torch_serialize}, and the second must
#' accept a raw vector and return a list of external pointer type objects,
#' e.g. \code{torch::torch_load},\cr \strong{or else} NULL to reset.
#'
#' @return Invisibly, a list comprising the currently-registered 'refhook'
#' functions. If functions are successfully registered or reset, a message
#' is printed to the console.
#'
#' @details Calling without any arguments returns a list of the
#' @param refhook \strong{either} a list or pairlist of two functions: the
#' signature for the first must accept a list of external pointer type
#' objects and return a raw vector, e.g. \code{torch::torch_serialize}, and
#' the second must accept a raw vector and return a list of external pointer
#' type objects, e.g. \code{torch::torch_load},\cr \strong{or else} NULL to
#' reset.
#'
#' @return Invisibly, the pairlist of currently-registered 'refhook' functions.
#' A message is printed to the console when functions are successfully
#' registered or reset.
#'
#' @details Calling without any arguments returns the pairlist of
#' currently-registered 'refhook' functions.
#'
#' This function may be called prior to or after setting daemons, with the
Expand Down
19 changes: 10 additions & 9 deletions man/serialization.Rd

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

0 comments on commit 40b45fe

Please sign in to comment.