Request for Examples, Documentation Illustrating use with other libraries
gwpl opened this issue · 3 comments
Could you please consider adding examples to your repository?
Also examples showing how to use your crate and e.g.
- calculate distances between vectors (here is some inspiration in python: https://gist.github.com/gwpl/4f6c2aa1401febbf0873859495496315 )
Or show how to use with other rust AI libraries, vector dbs or math libraries, to compute different kinds of distances, similarities ( [Dot product: Dot], [Cosine similarity: Cosine], [Euclidean distance: Euclid], [Manhattan distance: Manhattan] ).
Ideal would be tiny [[example programs in examples
directory] that could be run with cargo.
Probably examples showing potential with some DBs also wouldn't hurt:
Hi @gwpl. Thanks for raising the issue.
I usually work in the library during weekends. I can take a look then.
In the meantime, contributions are welcome.
I am thinking the library's interface is simple and docs.rs/README should be sufficient.