annoy_load_bigmatrix: Load an existing Annoy index for bigmatrix workflows

In bigANNOY: Approximate k-Nearest Neighbour Search for 'bigmemory' Matrices with Annoy

Load an existing Annoy index for bigmatrix workflows

Description

Load an existing Annoy index for bigmatrix workflows

Usage

annoy_load_bigmatrix(
  path,
  metadata_path = NULL,
  prefault = FALSE,
  load_mode = "eager"
)

Arguments

path	File path to an existing Annoy index built by annoy_build_bigmatrix().
metadata_path	Optional path to the sidecar metadata file.
prefault	Logical flag indicating whether searches should prefault the index when loaded by the native backend.
load_mode	Whether to eagerly load the native index handle on open or defer until first search.

Value

A bigannoy_index object that can be passed to annoy_search_bigmatrix().

bigANNOY documentation built on April 1, 2026, 9:07 a.m.