bibtex block in documentation

terrierteam · Nov 25, 2024 · da7d1f2 · da7d1f2
1 parent de40c5a
commit da7d1f2
Showing 1 changed file with 44 additions and 2 deletions.
diff --git a/pyterrier_dr/prf.py b/pyterrier_dr/prf.py
@@ -21,7 +21,28 @@ class VectorPrf(pt.Transformer):
     
             prf_pipe = model >> index >> index.vec_loader() >> pyterier_dr.vector_prf() >> index 
 
-    Reference: Hang Li, Ahmed Mourad, Shengyao Zhuang, Bevan Koopman, Guido Zuccon. [Pseudo Relevance Feedback with Deep Language Models and Dense Retrievers: Successes and Pitfalls](https://arxiv.org/pdf/2108.11044.pdf)
+    .. code-block:: bibtex
+        :caption: Citation
+
+        @article{DBLP:journals/tois/0009MZKZ23,
+          author       = {Hang Li and
+                          Ahmed Mourad and
+                          Shengyao Zhuang and
+                          Bevan Koopman and
+                          Guido Zuccon},
+          title        = {Pseudo Relevance Feedback with Deep Language Models and Dense Retrievers:
+                          Successes and Pitfalls},
+          journal      = {{ACM} Trans. Inf. Syst.},
+          volume       = {41},
+          number       = {3},
+          pages        = {62:1--62:40},
+          year         = {2023},
+          url          = {https://doi.org/10.1145/3570724},
+          doi          = {10.1145/3570724},
+          timestamp    = {Fri, 21 Jul 2023 22:26:51 +0200},
+          biburl       = {https://dblp.org/rec/journals/tois/0009MZKZ23.bib},
+          bibsource    = {dblp computer science bibliography, https://dblp.org}
+        }
     """
     def __init__(self,
         *,
@@ -65,7 +86,28 @@ class AveragePrf(pt.Transformer):
     
             prf_pipe = model >> index >> index.vec_loader() >> pyterier_dr.average_prf() >> index 
 
-    Reference: Hang Li, Ahmed Mourad, Shengyao Zhuang, Bevan Koopman, Guido Zuccon. [Pseudo Relevance Feedback with Deep Language Models and Dense Retrievers: Successes and Pitfalls](https://arxiv.org/pdf/2108.11044.pdf)
+    .. code-block:: bibtex
+        :caption: Citation
+
+        @article{DBLP:journals/tois/0009MZKZ23,
+          author       = {Hang Li and
+                          Ahmed Mourad and
+                          Shengyao Zhuang and
+                          Bevan Koopman and
+                          Guido Zuccon},
+          title        = {Pseudo Relevance Feedback with Deep Language Models and Dense Retrievers:
+                          Successes and Pitfalls},
+          journal      = {{ACM} Trans. Inf. Syst.},
+          volume       = {41},
+          number       = {3},
+          pages        = {62:1--62:40},
+          year         = {2023},
+          url          = {https://doi.org/10.1145/3570724},
+          doi          = {10.1145/3570724},
+          timestamp    = {Fri, 21 Jul 2023 22:26:51 +0200},
+          biburl       = {https://dblp.org/rec/journals/tois/0009MZKZ23.bib},
+          bibsource    = {dblp computer science bibliography, https://dblp.org}
+        }
     """
     def __init__(self,
         *,