Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
cff-version: 1.2.0
message: "If you use Vicinity in your research, please cite it as below."
title: "Vicinity: Lightweight Nearest Neighbors with Flexible Backends"
authors:
- family-names: "Tulkens"
given-names: "Stephan"
- family-names: "van Dongen"
given-names: "Thomas"
doi: 10.5281/zenodo.17265874
license: MIT
url: "https://github.com/MinishLab/vicinity"
repository-code: "https://github.com/MinishLab/vicinity"
date-released: "2024-11-09"

preferred-citation:
type: software
title: "Vicinity: Lightweight Nearest Neighbors with Flexible Backends"
authors:
- family-names: "Tulkens"
given-names: "Stephan"
- family-names: "van Dongen"
given-names: "Thomas"
year: 2024
publisher: Zenodo
doi: 10.5281/zenodo.17265874
url: "https://github.com/MinishLab/vicinity"
license: MIT
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,3 +198,19 @@ pip install vicinity[voyager]
## License

MIT

## Citing

If you use Vicinity in your research, please cite the following:

```bibtex
@software{minishlab2024vicinity,
author = {Stephan Tulkens and {van Dongen}, Thomas},
title = {Vicinity: Lightweight Nearest Neighbors with Flexible Backends},
year = {2024},
publisher = {Zenodo},
doi = {10.5281/zenodo.17265874},
url = {https://github.com/MinishLab/vicinity},
license = {MIT}
}
```