Scalable Vector Search
Contents:
Introduction
Getting started with Python
Getting started with C++
Library Features
How-Tos
I/O and Conversion Tools
Performance Tuning
Advanced Topics
Benchmarks
Roadmap
FAQ
Logging
Python API
Common Python API
Loaders
Flat Index
Vamana Graph Index
Dynamic Vamana Graph Index
Backend Selection
Object Upgrader
Python Logging API
C++ Documentation
C++ Library
Indexes
Core Components
Quantization Support
Core Concepts
Internals
Testing
Experimental Python Library
Using LeanVec
Scalable Vector Search
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
_
__init__() (pysvs.DynamicVamana method)
(pysvs.Flat method)
(pysvs.LeanVecLoader method)
(pysvs.LVQLoader method)
(pysvs.SearchBufferConfig method)
(pysvs.Vamana method)
(pysvs.VamanaBuildParameters method)
(pysvs.VamanaCalibrationParameters method)
(pysvs.VamanaSearchParameters method)
(pysvs.VectorDataLoader method)
A
add() (pysvs.DynamicVamana method)
alignment (pysvs.LeanVecLoader property)
all_ids() (pysvs.DynamicVamana method)
all_unique (C++ function)
alpha (pysvs.DynamicVamana property)
ANNEXCEPTION (C macro)
available_backends() (in module pysvs.loader)
B
buffer_config (pysvs.VamanaSearchParameters attribute)
build() (pysvs.DynamicVamana static method)
(pysvs.Vamana static method)
C
compact() (pysvs.DynamicVamana method)
comparator (C++ function)
compare_t (C++ type)
compute (C++ function)
,
[1]
,
[2]
,
[3]
consolidate() (pysvs.DynamicVamana method)
const_value_type_t (C++ type)
construction_window_size (pysvs.DynamicVamana property)
convert_fvecs_to_float16() (in module pysvs)
convert_vecs_to_svs() (in module pysvs)
cpp_type_t (C++ type)
current_backend() (in module pysvs.loader)
D
data_type (pysvs.VectorDataLoader property)
DataType (C++ enum)
(class in pysvs)
DataType::byte (C++ enumerator)
DataType::float16 (C++ enumerator)
DataType::float32 (C++ enumerator)
DataType::float64 (C++ enumerator)
DataType::int16 (C++ enumerator)
DataType::int32 (C++ enumerator)
DataType::int64 (C++ enumerator)
DataType::int8 (C++ enumerator)
DataType::uint16 (C++ enumerator)
DataType::uint32 (C++ enumerator)
DataType::uint64 (C++ enumerator)
DataType::uint8 (C++ enumerator)
DataType::undef (C++ enumerator)
datatype_v (C++ member)
delete() (pysvs.DynamicVamana method)
dimensions (pysvs.DynamicVamana property)
(pysvs.Flat property)
(pysvs.Vamana property)
dims (pysvs.LeanVecLoader property)
(pysvs.LVQLoader property)
(pysvs.VectorDataLoader property)
DistanceType (class in pysvs)
DRAM (class in pysvs)
Dynamic (C++ member)
DynamicVamana (class in pysvs)
E
experimental_backend_string (pysvs.DynamicVamana property)
(pysvs.Vamana property)
experimental_calibrate() (pysvs.DynamicVamana method)
(pysvs.Vamana method)
experimental_reset_performance_parameters() (pysvs.DynamicVamana method)
(pysvs.Vamana method)
F
filepath (pysvs.VectorDataLoader property)
Flat (class in pysvs)
for_each_type (C++ function)
format (C++ function)
G
generate_test_dataset() (in module pysvs)
get_level() (in module pysvs.logging)
graphs_equal (C++ function)
H
has_datatype_v (C++ member)
has_id() (pysvs.DynamicVamana method)
I
implicitly_broadcastable (C++ function)
in (C++ function)
,
[1]
index_type_t (C++ type)
K
k_recall_at_n (C++ function)
L
leanvec_dims (pysvs.LeanVecLoader property)
LeanVecKind (class in pysvs)
LeanVecLoader (class in pysvs)
level (class in pysvs.logging)
library() (in module pysvs.loader)
log_message() (in module pysvs.logging)
LVQLoader (class in pysvs)
LVQStrategy (class in pysvs)
M
make_dense_array (C++ function)
maybe_fix_argument (C++ function)
module
pysvs.loader
pysvs.logging
N
name (C++ function)
,
[1]
(pysvs.logging.level property)
(pysvs.logging.stream property)
(pysvs.VamanaSearchBufferOptimization property)
num_threads (pysvs.DynamicVamana property)
(pysvs.Flat property)
(pysvs.Vamana property)
P
prefetch_lookahead (pysvs.VamanaSearchParameters attribute)
prefetch_step (pysvs.VamanaSearchParameters attribute)
prefetch_steps (pysvs.VamanaCalibrationParameters attribute)
primary_bits (pysvs.LVQLoader property)
primary_kind (pysvs.LeanVecLoader property)
pysvs.loader
module
pysvs.logging
module
Q
query_types (pysvs.DynamicVamana property)
(pysvs.Flat property)
(pysvs.Vamana property)
R
read_binary (C++ function)
,
[1]
read_svs() (in module pysvs)
read_vecs() (in module pysvs)
recall_convert (C++ function)
,
[1]
reconstruct() (pysvs.DynamicVamana method)
(pysvs.Vamana method)
reload_from() (pysvs.LeanVecLoader method)
(pysvs.LVQLoader method)
residual_bits (pysvs.LVQLoader property)
S
save (C++ function)
,
[1]
save() (pysvs.DynamicVamana method)
(pysvs.Vamana method)
search() (pysvs.DynamicVamana method)
(pysvs.Flat method)
(pysvs.Vamana method)
search_buffer_capacity (pysvs.SearchBufferConfig attribute)
search_buffer_optimization (pysvs.VamanaCalibrationParameters attribute)
search_buffer_visited_set (pysvs.VamanaSearchParameters attribute)
search_parameters (pysvs.DynamicVamana property)
(pysvs.Flat property)
(pysvs.Vamana property)
search_timeout (pysvs.VamanaCalibrationParameters attribute)
search_window_capacity_upper (pysvs.VamanaCalibrationParameters attribute)
search_window_size (pysvs.DynamicVamana property)
(pysvs.SearchBufferConfig attribute)
(pysvs.Vamana property)
search_window_size_upper (pysvs.VamanaCalibrationParameters attribute)
SearchBufferConfig (class in pysvs)
secondary_kind (pysvs.LeanVecLoader property)
set_level() (in module pysvs.logging)
set_logging_file() (in module pysvs.logging)
set_logging_stream() (in module pysvs.logging)
size (pysvs.DynamicVamana property)
(pysvs.Flat property)
(pysvs.Vamana property)
strategy (pysvs.LVQLoader property)
stream (class in pysvs.logging)
svs::data::ConstSimpleDataView (C++ type)
svs::data::SimpleData (C++ class)
svs::data::SimpleData::allocator_type (C++ type)
svs::data::SimpleData::capacity (C++ function)
svs::data::SimpleData::const_value_type (C++ type)
svs::data::SimpleData::cview (C++ function)
svs::data::SimpleData::data (C++ function)
,
[1]
svs::data::SimpleData::dimensions (C++ function)
svs::data::SimpleData::element_type (C++ type)
svs::data::SimpleData::extent (C++ member)
svs::data::SimpleData::get_allocator (C++ function)
svs::data::SimpleData::get_datum (C++ function)
,
[1]
svs::data::SimpleData::is_const (C++ member)
svs::data::SimpleData::is_memory_map_compatible (C++ member)
svs::data::SimpleData::is_view (C++ member)
svs::data::SimpleData::load (C++ function)
,
[1]
svs::data::SimpleData::prefetch (C++ function)
svs::data::SimpleData::resize (C++ function)
svs::data::SimpleData::set_datum (C++ function)
svs::data::SimpleData::shrink_to_fit (C++ function)
svs::data::SimpleData::SimpleData (C++ function)
svs::data::SimpleData::size (C++ function)
svs::data::SimpleData::value_type (C++ type)
svs::data::SimpleData::view (C++ function)
,
[1]
svs::data::SimpleDataView (C++ type)
svs::DenseArray (C++ class)
svs::DenseArray::at (C++ function)
,
[1]
svs::DenseArray::begin (C++ function)
,
[1]
svs::DenseArray::bytes (C++ function)
svs::DenseArray::cview (C++ function)
svs::DenseArray::dims (C++ function)
svs::DenseArray::end (C++ function)
,
[1]
svs::DenseArray::extent (C++ function)
svs::DenseArray::first (C++ function)
svs::DenseArray::getextent (C++ function)
svs::DenseArray::getsize (C++ function)
svs::DenseArray::last (C++ function)
svs::DenseArray::ndims (C++ function)
svs::DenseArray::size (C++ function)
svs::DenseArray::slice (C++ function)
,
[1]
svs::DenseArray::view (C++ function)
,
[1]
svs::distance::BroadcastDistance (C++ class)
svs::distance::BroadcastDistance::BroadcastDistance (C++ function)
svs::distance::BroadcastDistance::operator[] (C++ function)
svs::distance::BroadcastDistance::resize (C++ function)
svs::distance::BroadcastDistance::size (C++ function)
svs::distance::DistanceCosineSimilarity (C++ struct)
svs::distance::DistanceCosineSimilarity::compare (C++ type)
svs::distance::DistanceCosineSimilarity::fix_argument (C++ function)
svs::distance::DistanceCosineSimilarity::implicit_broadcast (C++ member)
svs::distance::DistanceCosineSimilarity::must_fix_argument (C++ member)
svs::distance::DistanceIP (C++ struct)
svs::distance::DistanceIP::compare (C++ type)
svs::distance::DistanceIP::implicit_broadcast (C++ member)
svs::distance::DistanceL2 (C++ struct)
svs::distance::DistanceL2::compare (C++ type)
svs::distance::DistanceL2::implicit_broadcast (C++ member)
svs::distance_type_v (C++ member)
svs::DistanceDispatcher (C++ class)
svs::DistanceDispatcher::DistanceDispatcher (C++ function)
svs::DistanceDispatcher::operator() (C++ function)
svs::DistanceType (C++ enum)
svs::DistanceType::Cosine (C++ enumerator)
svs::DistanceType::L2 (C++ enumerator)
svs::DistanceType::MIP (C++ enumerator)
svs::Flat (C++ class)
svs::Flat::assemble (C++ function)
svs::Flat::AssembleTag (C++ struct)
svs::Flat::can_change_threads (C++ function)
svs::Flat::dimensions (C++ function)
svs::Flat::get_num_threads (C++ function)
svs::Flat::query_types (C++ function)
svs::Flat::search_parameters_type (C++ type)
svs::Flat::set_num_threads (C++ function)
svs::Flat::size (C++ function)
svs::GraphLoader (C++ struct)
svs::GraphLoader::GraphLoader (C++ function)
svs::GraphLoader::load (C++ function)
svs::graphs::SimpleGraph (C++ class)
svs::graphs::SimpleGraph::add_edge (C++ function)
svs::graphs::SimpleGraph::clear_node (C++ function)
svs::graphs::SimpleGraph::const_reference (C++ type)
svs::graphs::SimpleGraph::get_node (C++ function)
svs::graphs::SimpleGraph::get_node_degree (C++ function)
svs::graphs::SimpleGraph::has_edge (C++ function)
svs::graphs::SimpleGraph::index_type (C++ type)
svs::graphs::SimpleGraph::max_degree (C++ function)
svs::graphs::SimpleGraph::n_nodes (C++ function)
svs::graphs::SimpleGraph::prefetch_node (C++ function)
svs::graphs::SimpleGraph::reference (C++ type)
svs::graphs::SimpleGraph::replace_node (C++ function)
svs::graphs::SimpleGraph::reset (C++ function)
svs::graphs::SimpleGraph::SimpleGraph (C++ function)
svs::HugepageAllocator (C++ class)
svs::HugepageAllocator::HugepageAllocator (C++ function)
,
[1]
svs::index::flat::auto_assemble (C++ function)
svs::index::flat::FlatIndex (C++ class)
svs::index::flat::FlatIndex::can_change_threads (C++ function)
svs::index::flat::FlatIndex::data_type (C++ type)
svs::index::flat::FlatIndex::dimensions (C++ function)
svs::index::flat::FlatIndex::distance_type (C++ type)
svs::index::flat::FlatIndex::FlatIndex (C++ function)
svs::index::flat::FlatIndex::get_num_threads (C++ function)
svs::index::flat::FlatIndex::search (C++ function)
svs::index::flat::FlatIndex::set_num_threads (C++ function)
svs::index::flat::FlatIndex::size (C++ function)
svs::index::vamana::auto_assemble (C++ function)
svs::index::vamana::auto_build (C++ function)
svs::index::vamana::VamanaBuildParameters (C++ struct)
svs::index::vamana::VamanaBuildParameters::alpha (C++ member)
svs::index::vamana::VamanaBuildParameters::graph_max_degree (C++ member)
svs::index::vamana::VamanaBuildParameters::max_candidate_pool_size (C++ member)
svs::index::vamana::VamanaBuildParameters::prune_to (C++ member)
svs::index::vamana::VamanaBuildParameters::use_full_search_history (C++ member)
svs::index::vamana::VamanaBuildParameters::window_size (C++ member)
svs::index::vamana::VamanaIndex (C++ class)
svs::index::vamana::VamanaIndex::apply (C++ function)
svs::index::vamana::VamanaIndex::borrow_threadpool (C++ function)
svs::index::vamana::VamanaIndex::can_change_threads (C++ function)
svs::index::vamana::VamanaIndex::const_value_type (C++ type)
svs::index::vamana::VamanaIndex::data_type (C++ type)
svs::index::vamana::VamanaIndex::dimensions (C++ function)
svs::index::vamana::VamanaIndex::distance_type (C++ type)
svs::index::vamana::VamanaIndex::extent (C++ member)
svs::index::vamana::VamanaIndex::get_alpha (C++ function)
svs::index::vamana::VamanaIndex::get_construction_window_size (C++ function)
svs::index::vamana::VamanaIndex::get_distance (C++ function)
svs::index::vamana::VamanaIndex::get_full_search_history (C++ function)
svs::index::vamana::VamanaIndex::get_max_candidates (C++ function)
svs::index::vamana::VamanaIndex::get_num_threads (C++ function)
svs::index::vamana::VamanaIndex::get_search_parameters (C++ function)
svs::index::vamana::VamanaIndex::graph_type (C++ type)
svs::index::vamana::VamanaIndex::Idx (C++ type)
svs::index::vamana::VamanaIndex::inner_scratch_type (C++ type)
svs::index::vamana::VamanaIndex::reconstruct_at (C++ function)
svs::index::vamana::VamanaIndex::reset_performance_parameters (C++ function)
svs::index::vamana::VamanaIndex::save (C++ function)
svs::index::vamana::VamanaIndex::scratchspace (C++ function)
,
[1]
svs::index::vamana::VamanaIndex::search (C++ function)
,
[1]
svs::index::vamana::VamanaIndex::search_parameters_type (C++ type)
svs::index::vamana::VamanaIndex::set_full_search_history (C++ function)
svs::index::vamana::VamanaIndex::set_num_threads (C++ function)
svs::index::vamana::VamanaIndex::size (C++ function)
svs::index::vamana::VamanaIndex::value_type (C++ type)
svs::index::vamana::VamanaIndex::VamanaIndex (C++ function)
,
[1]
svs::index::vamana::VamanaSearchParameters (C++ struct)
svs::index::vamana::VamanaSearchParameters::buffer_config_ (C++ member)
svs::index::vamana::VamanaSearchParameters::prefetch_lookahead_ (C++ member)
svs::index::vamana::VamanaSearchParameters::prefetch_step_ (C++ member)
svs::index::vamana::VamanaSearchParameters::search_buffer_visited_set_ (C++ member)
svs::lib::ANNException (C++ class)
svs::lib::ANNException::ANNException (C++ function)
svs::lib::dispatch_convert (C++ function)
svs::lib::dispatch_description (C++ function)
svs::lib::dispatch_match (C++ function)
svs::lib::DispatchConverter (C++ struct)
svs::lib::Dispatcher (C++ class)
svs::lib::Dispatcher::best_match (C++ function)
svs::lib::Dispatcher::description (C++ function)
svs::lib::Dispatcher::Dispatcher (C++ function)
svs::lib::Dispatcher::has_match (C++ function)
svs::lib::Dispatcher::invoke (C++ function)
svs::lib::Dispatcher::match_type (C++ type)
svs::lib::Dispatcher::num_args (C++ function)
svs::lib::Dispatcher::register_target (C++ function)
,
[1]
svs::lib::Dispatcher::size (C++ function)
svs::lib::dispatcher_build_docs (C++ member)
svs::lib::dispatcher_no_docs (C++ member)
svs::lib::DispatchTarget (C++ class)
svs::lib::DispatchTarget::arg_signature_type (C++ type)
svs::lib::DispatchTarget::check_match (C++ function)
svs::lib::DispatchTarget::description (C++ function)
svs::lib::DispatchTarget::DispatchTarget (C++ function)
,
[1]
svs::lib::DispatchTarget::invoke (C++ function)
svs::lib::DispatchTarget::match_type (C++ type)
svs::lib::DispatchTarget::num_args (C++ member)
svs::lib::DispatchTarget::signature_type (C++ type)
svs::lib::imperfect_match (C++ member)
svs::lib::implicit_match (C++ member)
svs::lib::invalid_match (C++ member)
svs::lib::LoadContext (C++ class)
svs::lib::LoadContext::get_directory (C++ function)
svs::lib::LoadContext::resolve (C++ function)
svs::lib::LoadContext::version (C++ function)
svs::lib::MinMax (C++ struct)
svs::lib::MinMax::init (C++ function)
svs::lib::MinMax::min (C++ member)
svs::lib::perfect_match (C++ member)
svs::lib::save_to_disk (C++ function)
svs::lib::save_to_table (C++ function)
svs::lib::SaveContext (C++ class)
svs::lib::SaveContext::generate_name (C++ function)
svs::lib::SaveContext::get_directory (C++ function)
svs::lib::SaveContext::SaveContext (C++ function)
svs::lib::SaveTable (C++ class)
svs::lib::SaveTable::contains (C++ function)
svs::lib::SaveTable::insert (C++ function)
svs::lib::SaveTable::SaveTable (C++ function)
,
[1]
svs::lib::Type (C++ struct)
svs::lib::Type::operator DataType (C++ function)
svs::lib::Type::type (C++ type)
svs::lib::Types (C++ struct)
svs::lib::Types::data_types (C++ function)
svs::lib::Types::size (C++ member)
svs::lib::Val (C++ class)
svs::lib::Val::Val (C++ function)
svs::lib::Val::value (C++ member)
svs::lib::variant::VariantDispatcher (C++ struct)
svs::lib::variant::VariantDispatcher::convert (C++ function)
svs::lib::variant::VariantDispatcher::description (C++ function)
svs::lib::variant::VariantDispatcher::match (C++ function)
svs::lib::write_binary (C++ function)
svs::logging::file_sink (C++ function)
svs::logging::get (C++ function)
svs::logging::global_logger (C++ function)
svs::logging::Level (C++ enum)
svs::logging::Level::Critical (C++ enumerator)
svs::logging::Level::Debug (C++ enumerator)
svs::logging::Level::Error (C++ enumerator)
svs::logging::Level::Info (C++ enumerator)
svs::logging::Level::Off (C++ enumerator)
svs::logging::Level::Trace (C++ enumerator)
svs::logging::Level::Warn (C++ enumerator)
svs::logging::log (C++ function)
,
[1]
svs::logging::logger_ptr (C++ type)
svs::logging::null_sink (C++ function)
svs::logging::set (C++ function)
,
[1]
svs::logging::sink_ptr (C++ type)
svs::logging::stderr_sink (C++ function)
svs::logging::stdout_sink (C++ function)
svs::MemoryMapper (C++ class)
svs::MemoryMapper::MemoryMapper (C++ function)
svs::MemoryMapper::Permission (C++ enum)
svs::MemoryMapper::Permission::ReadOnly (C++ enumerator)
svs::MemoryMapper::Permission::ReadWrite (C++ enumerator)
svs::MemoryMapper::Policy (C++ enum)
svs::MemoryMapper::Policy::MayCreate (C++ enumerator)
svs::MemoryMapper::Policy::MustCreate (C++ enumerator)
svs::MemoryMapper::Policy::MustUseExisting (C++ enumerator)
svs::MMapPtr (C++ class)
svs::MMapPtr::base (C++ function)
,
[1]
svs::MMapPtr::data (C++ function)
,
[1]
svs::MMapPtr::MMapPtr (C++ function)
,
[1]
svs::MMapPtr::setoffset (C++ function)
svs::MMapPtr::size (C++ function)
svs::quantization::lvq::LVQDataset (C++ class)
svs::quantization::lvq::LVQDataset::get_datum (C++ function)
svs::quantization::lvq::LVQDataset::get_primary (C++ function)
svs::quantization::lvq::LVQDataset::prefetch (C++ function)
svs::quantization::lvq::LVQDataset::prefetch_primary (C++ function)
svs::quantization::lvq::LVQDataset::primary_dataset_alignment (C++ function)
svs::quantization::lvq::Reload (C++ struct)
svs::quantization::lvq::Reload::Reload (C++ function)
svs::QueryResult (C++ type)
svs::QueryResultImpl (C++ class)
svs::QueryResultImpl::distance (C++ function)
,
[1]
svs::QueryResultImpl::distances (C++ function)
,
[1]
svs::QueryResultImpl::index (C++ function)
,
[1]
svs::QueryResultImpl::indices (C++ function)
,
[1]
svs::QueryResultImpl::n_neighbors (C++ function)
svs::QueryResultImpl::n_queries (C++ function)
svs::QueryResultImpl::QueryResultImpl (C++ function)
,
[1]
svs::QueryResultImpl::save_vecs (C++ function)
svs::QueryResultImpl::view (C++ function)
svs::QueryResultView (C++ type)
svs::Vamana (C++ class)
svs::Vamana::assemble (C++ function)
svs::Vamana::build (C++ function)
svs::Vamana::can_change_threads (C++ function)
svs::Vamana::dimensions (C++ function)
svs::Vamana::get_alpha (C++ function)
svs::Vamana::get_max_candidates (C++ function)
svs::Vamana::get_num_threads (C++ function)
svs::Vamana::query_types (C++ function)
svs::Vamana::save (C++ function)
svs::Vamana::search_parameters_type (C++ type)
svs::Vamana::set_num_threads (C++ function)
svs::Vamana::size (C++ function)
svs::VectorDataLoader (C++ class)
svs::VectorDataLoader::get_path (C++ function)
svs::VectorDataLoader::load (C++ function)
svs::VectorDataLoader::return_type (C++ type)
svs::VectorDataLoader::VectorDataLoader (C++ function)
T
timing_iterations (pysvs.VamanaCalibrationParameters attribute)
train_prefetchers (pysvs.VamanaCalibrationParameters attribute)
U
upgrade() (pysvs.upgrader method)
use_existing_parameter_values (pysvs.VamanaCalibrationParameters attribute)
V
value_type_t (C++ type)
Vamana (class in pysvs)
VamanaBuildParameters (class in pysvs)
VamanaCalibrationParameters (class in pysvs)
VamanaSearchBufferOptimization (class in pysvs)
VamanaSearchParameters (class in pysvs)
VectorDataLoader (class in pysvs)
visited_set_enabled (pysvs.DynamicVamana property)
(pysvs.Vamana property)
W
write_vecs() (in module pysvs)