#include <AutoTune.h>

Inheritance diagram for faiss::ParameterSpace:

Public Member Functions
size_t	n_combinations () const
	nb of combinations, = product of values sizes

bool	combination_ge (size_t c1, size_t c2) const
	returns whether combinations c1 >= c2 in the tuple sense

std::string	combination_name (size_t cno) const
	get string representation of the combination

void	display () const
	print a description on stdout

ParameterRange &	add_range (const char *name)
	add a new parameter

virtual void	initialize (const Index *index)
	initialize with reasonable parameters for the index

void	set_index_parameters (Index *index, size_t cno) const
	set a combination of parameters on an index

void	set_index_parameters (Index index, const char param_string) const
	set a combination of parameters described by a string More...

virtual void	set_index_parameter (Index *index, const std::string &name, double val) const
	set one of the parameters

void	update_bounds (size_t cno, const OperatingPoint &op, double upper_bound_perf, double lower_bound_t) const

void	explore (Index index, size_t nq, const float xq, const AutoTuneCriterion &crit, OperatingPoints *ops) const

Public Attributes
std::vector< ParameterRange >	parameter_ranges
	all tunable parameters

int	verbose
	verbosity during exploration

int	n_experiments
	nb of experiments during optimization (0 = try all combinations)

size_t	batchsize
	maximum number of queries to submit at a time.

bool	thread_over_batches

Detailed Description

Uses a-priori knowledge on the Faiss indexes to extract tunable parameters.

Definition at line 133 of file AutoTune.h.

Member Function Documentation

void faiss::ParameterSpace::explore	(	Index *	index,
		size_t	nq,
		const float *	xq,
		const AutoTuneCriterion &	crit,
		OperatingPoints *	ops
	)		const

explore operating points

Parameters

Definition at line 512 of file AutoTune.cpp.

void faiss::ParameterSpace::set_index_parameters	(	Index *	index,
		const char *	param_string
	)		const

set a combination of parameters described by a string

set a combination of parameters on an index

Definition at line 401 of file AutoTune.cpp.

void faiss::ParameterSpace::update_bounds	(	size_t	cno,
		const OperatingPoint &	op,
		double *	upper_bound_perf,
		double *	lower_bound_t
	)		const

find an upper bound on the performance and a lower bound on t for configuration cno given another operating point op

Definition at line 498 of file AutoTune.cpp.

bool faiss::ParameterSpace::thread_over_batches

use multithreading over batches (useful to benchmark independent single-searches)

Definition at line 150 of file AutoTune.h.

The documentation for this struct was generated from the following files: