This function is only present in the core library version of CyborgDB.
In other versions (microservice, serverless), it is automatically called once enough vector embeddings have been indexed.
Parameters
Parameter | Type | Description |
---|---|---|
training_config | TrainingConfig | (Optional) Training parameters (batch size, max iterations, etc.). |
There must be at least
2 * n_lists
vector embeddings in the index prior to to calling this function.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.