Skip to contents

Performs t-SNE dimensionality reduction on the input data. This function provides a user-friendly interface with input validation before calling the Rust implementation.

Usage

tsne(
  data,
  knn = NULL,
  n_dim = 2L,
  perplexity = 20,
  approx_type = c("bh", "bh_qd", "fft", "fft_3k"),
  knn_method = c("ivf", "kmknn", "balltree", "hnsw", "annoy", "nndescent", "exhaustive"),
  nn_params = params_nn(),
  tsne_params = params_tsne(),
  seed = 42L,
  .verbose = TRUE
)

Arguments

data

Numerical matrix or data frame. The data to embed of shape samples x features. Will be coerced to a matrix.

knn

Optional NearestNeighbours class. If provided, t-SNE will skip the k-nearest neighbour graph generation and use this one. Needs more neighbours than perplexity; the internal search uses 3 * perplexity. Defaults to NULL.

n_dim

Integer. Number of dimensions in the embedding space. Currently only 2L is supported. Defaults to 2L.

perplexity

Numeric. Perplexity parameter, related to the number of nearest neighbours used in manifold learning. Typical values are between 5 and 50. Defaults to 20.0.

approx_type

Character. Approximation method for computing repulsive forces. One of "bh" for Barnes-Hut, "bh_qd" for the quick-and-dirty Barnes-Hut of qdtsne (tree depth capped at max_depth in params_tsne(), repulsion computed once per leaf), "fft" for FFT-accelerated interpolation or "fft_3k" for the three-kernel variant of the latter (one forward and three inverse FFTs per epoch instead of four each). Defaults to "bh".

knn_method

Character. (Approximate) Nearest neighbour method to use. One of "kmknn", "hnsw", "annoy", "nndescent", "balltree", "ivf" or "exhaustive". Defaults to "ivf".

nn_params

Named list. Nearest neighbour search parameters, see params_nn().

tsne_params

Named list. t-SNE algorithm parameters, see params_tsne().

seed

Integer. Random seed for reproducibility.

.verbose

Logical or integer. Controls verbosity. TRUE or 1L prints timed stages and epochs every 50, 2L adds parameters and the kNN internals, FALSE or 0L is silent. Defaults to TRUE.

Value

A numerical matrix with dimensions samples x n_dim containing the t-SNE embedding.

Details

The number of neighbours will be `3 * perplexity“, as this is a usual default in tSNE.

Examples

d <- manifold_synthetic_data(type = "clusters", n_samples = 500L)
emb <- tsne(d$data, .verbose = FALSE)
dim(emb)
#> [1] 500   2