Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

refactor(llama_index_rm): per pr comments

Patrick Miramontesa2f2bd26eaa7
diff --git a/dspy/retrieve/llama_index_rm.py b/dspy/retrieve/llama_index_rm.py
index 0b861bdf4..5a462abb1 100644
--- a/dspy/retrieve/llama_index_rm.py
+++ b/dspy/retrieve/llama_index_rm.py
@@ -1,3 +1,6 @@
+import logging
+from typing import Optional
+
import dspy
try:
@@ -6,6 +9,8 @@ except ImportError:
err = "The 'llama_index' package is required to use LlamaIndexRM. Install it with 'pip install llama_index'."
raise ImportError(err) from None
+NO_TOP_K_WARNING = "The underlying LlamaIndex retriever does not support top k retrieval. Ignoring k value."
+
class LlamaIndexRM(dspy.Retrieve):
"""Implements a retriever which wraps over a LlamaIndex retriever.
@@ -19,6 +24,9 @@ class LlamaIndexRM(dspy.Retrieve):
Args:
retriever (BaseRetriever): A LlamaIndex retriever object - text based only
+ k (int): Optional; the number of examples to retrieve (similarity_top_k)
+
+ If the underlying LI retriever does not have the property similarity_top_k, k will be ignored.
Returns:
DSPy RM Object - this is a retriever object that can be used in DSPy
@@ -26,32 +34,55 @@ class LlamaIndexRM(dspy.Retrieve):
retriever: BaseRetriever
- def __init__(self, retriever: BaseRetriever):
+ def __init__(
+ self,
+ retriever: BaseRetriever,
+ k: Optional[int] = 3,
+ ):
self.retriever = retriever
+ if hasattr(self.retriever, "similarity_top_k"):
+ self.retriever.similarity_top_k = k
+ else:
+ logging.warning(NO_TOP_K_WARNING)
+
@property
- def similarity_top_k(self) -> int:
- """Return similarity top k of retriever."""
+ def k(self) -> int:
+ """Get similarity top k of retriever."""
+ if not hasattr(self.retriever, "similarity_top_k"):
+ logging.warning(NO_TOP_K_WARNING)
+ return None
+
return self.retriever.similarity_top_k
- @similarity_top_k.setter
- def similarity_top_k(self, k: int) -> None:
+ @k.setter
+ def k(self, k: int) -> None:
"""Set similarity top k of retriever."""
- self.retriever.similarity_top_k = k
+ if hasattr(self.retriever, "similarity_top_k"):
+ self.retriever.similarity_top_k = k
+ else:
+ logging.warning(NO_TOP_K_WARNING)
- def forward(self, query: str) -> list[dspy.Example]:
+ def forward(self, query: str, k: Optional[int] = None) -> list[dspy.Example]:
"""Forward function for the LI retriever.
This is the function that is called to retrieve the top k examples for a given query.
-
Top k is set via the setter similarity_top_k or at LI instantiation.
Args:
query (str): The query to retrieve examples for
+ k (int): Optional; the number of examples to retrieve (similarity_top_k)
+
+ If the underlying LI retriever does not have the property similarity_top_k, k will be ignored.
Returns:
List[dspy.Example]: A list of examples retrieved by the retriever
"""
+ if hasattr(self.retriever, "similarity_top_k") and k:
+ self.retriever.similarity_top_k = k
+ else:
+ logging.warning(NO_TOP_K_WARNING)
+
raw = self.retriever.retrieve(query)
return [
diff --git a/tests/retrieve/test_llama_index_rm.py b/tests/retrieve/test_llama_index_rm.py
index 3223ad797..4bc3c41a4 100644
--- a/tests/retrieve/test_llama_index_rm.py
+++ b/tests/retrieve/test_llama_index_rm.py
@@ -7,16 +7,7 @@ from llama_index.core.readers.string_iterable import StringIterableReader
import dspy
from dsp.modules.dummy_lm import DummyLM
from dspy.datasets import HotPotQA
-from dspy.evaluate import Evaluate
from dspy.retrieve.llama_index_rm import LlamaIndexRM
-from dspy.teleprompt import BootstrapFinetune
-
-
-def validate_context_and_answer(example, pred, trace=None):
- """Copied this from the intro.ipynb"""
- answer_EM = dspy.evaluate.answer_exact_match(example, pred)
- answer_PM = dspy.evaluate.answer_passage_match(example, pred)
- return answer_EM and answer_PM
@pytest.fixture()
@@ -58,6 +49,4 @@ def test_lirm_as_rm(rag_setup):
assert isinstance(rm, dspy.Retrieve), "Ensuring the RM is a retriever object from dspy"
assert isinstance(test_res_dspy, list), "Ensuring the results are a list from the DSPy retriever"
- assert len(test_res_li) == len(
- test_res_dspy
- ), "Ensuring that the results are the same length, a rough equality check of the results"
+ assert len(test_res_li) == len(test_res_dspy), "Rough equality check of the results"