Parameters
Parameter | Type | Description |
---|---|---|
training_config | TrainingConfig | (Optional) Training parameters including n_lists, batch size, max iterations, tolerance, and max memory. |
There must be at least
2 * n_lists
or 10,000
(whichever is greater) vector embeddings in the index prior to calling this function. The n_lists
parameter is configured within the TrainingConfig
object.Exceptions
Throws if there are not enough vector embeddings in the index for training (must be at least2 * n_lists
).
std::runtime_exception
std::runtime_exception
- Throws if there are not enough vector embeddings in the index for training (must be at least
2 * n_lists
). - Throws if the index could not be trained.