Document parameters of FAISS

scikit-learn-contrib / sklearn-ann

Integration with (approximate) nearest neighbors libraries for scikit-learn + clustering based on with kNN-graphs.

https://sklearn-ann.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

15 stars 6 forks source link

Open ivirshup opened 7 months ago

ivirshup commented 7 months ago

It would be nice if the parameters of the transformers were documented more fully.

In particular, FAISS's index_key argument is not particularly intuitive, and I think can have fairly complex variations.