Skip to contents

Returns the default number of threads for UMAP computations. This is the option ggumap.n_threads or the environment variable GGUMAP_NUM_THREADS if set, and half of the available cores otherwise. It is limited to 2 when _R_CHECK_LIMIT_CORES_ is set (as during R CMD check).

Usage

umap_threads()

Value

A positive integer.

Details

With flavour = "0.5" results are only bit-for-bit reproducible when n_threads = 1. With flavour = "0.6" they are reproducible for a given number of threads.

Examples

umap_threads()
#> [1] 2

# Use a single thread for this session:
# options(ggumap.n_threads = 1)