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 | Default | Description |
---|---|---|---|
batch_size | int | 2048 | (Optional) Size of each batch for training. |
max_iters | int | 100 | (Optional) Maximum number of iterations for training. |
tolerance | float | 1e-6 | (Optional) Convergence tolerance for training. |
max_memory | int | 0 | (Optional) Maximum memory to use for training. 0 sets no limit. |
There must be at least
2 * n_lists
vector embeddings in the index prior to to calling this function.Exceptions
ValueError
ValueError
- Raises an exception if the index was not created or loaded yet.
RuntimeError
RuntimeError
- Raises an exception if there are not enough vector embeddings in the index for training (must be at least
2 * n_lists
). - Raises an exception if the index could not be trained.