From 73c7dea9ea7f88a23a7fa9a94e9a7bca48669f1c Mon Sep 17 00:00:00 2001
From: Xing Han Lu <21180505+xhluca@users.noreply.github.com>
Date: Wed, 10 Jul 2024 12:00:52 -0400
Subject: [PATCH] Update hf.py

---
 bm25s/hf.py | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/bm25s/hf.py b/bm25s/hf.py
index 0ab9ca8..e31b067 100644
--- a/bm25s/hf.py
+++ b/bm25s/hf.py
@@ -127,6 +127,23 @@
 | delta | `{delta}` |
 | method | `{method}` |
 | idf method | `{idf_method}` |
+
+## Citation
+
+To cite `bm25s`, please use the following bibtex:
+
+```
+@misc{lu_2024_bm25s,
+      title={BM25S: Orders of magnitude faster lexical search via eager sparse scoring}, 
+      author={Xing Han Lù},
+      year={2024},
+      eprint={2407.03618},
+      archivePrefix={arXiv},
+      primaryClass={cs.IR},
+      url={https://arxiv.org/abs/2407.03618}, 
+}
+```
+
 """