forked from Archives/langchain
Harrison Chase
1 year ago
committed by
GitHub
parent
0de55048b7
commit
23d5f64bda
@ -0,0 +1,112 @@
|
||||
"""Select and order examples based on ngram overlap score (sentence_bleu score).
|
||||
|
||||
https://www.nltk.org/_modules/nltk/translate/bleu_score.html
|
||||
https://aclanthology.org/P02-1040.pdf
|
||||
"""
|
||||
from typing import Dict, List
|
||||
|
||||
import numpy as np
|
||||
from pydantic import BaseModel, root_validator
|
||||
|
||||
from langchain.prompts.example_selector.base import BaseExampleSelector
|
||||
from langchain.prompts.prompt import PromptTemplate
|
||||
|
||||
|
||||
def ngram_overlap_score(source: List[str], example: List[str]) -> float:
|
||||
"""Compute ngram overlap score of source and example as sentence_bleu score.
|
||||
|
||||
Use sentence_bleu with method1 smoothing function and auto reweighting.
|
||||
Return float value between 0.0 and 1.0 inclusive.
|
||||
https://www.nltk.org/_modules/nltk/translate/bleu_score.html
|
||||
https://aclanthology.org/P02-1040.pdf
|
||||
"""
|
||||
from nltk.translate.bleu_score import ( # type: ignore
|
||||
SmoothingFunction,
|
||||
sentence_bleu,
|
||||
)
|
||||
|
||||
hypotheses = source[0].split()
|
||||
references = [s.split() for s in example]
|
||||
|
||||
return float(
|
||||
sentence_bleu(
|
||||
references,
|
||||
hypotheses,
|
||||
smoothing_function=SmoothingFunction().method1,
|
||||
auto_reweigh=True,
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
class NGramOverlapExampleSelector(BaseExampleSelector, BaseModel):
|
||||
"""Select and order examples based on ngram overlap score (sentence_bleu score).
|
||||
|
||||
https://www.nltk.org/_modules/nltk/translate/bleu_score.html
|
||||
https://aclanthology.org/P02-1040.pdf
|
||||
"""
|
||||
|
||||
examples: List[dict]
|
||||
"""A list of the examples that the prompt template expects."""
|
||||
|
||||
example_prompt: PromptTemplate
|
||||
"""Prompt template used to format the examples."""
|
||||
|
||||
threshold: float = -1.0
|
||||
"""Threshold at which algorithm stops. Set to -1.0 by default.
|
||||
|
||||
For negative threshold:
|
||||
select_examples sorts examples by ngram_overlap_score, but excludes none.
|
||||
For threshold greater than 1.0:
|
||||
select_examples excludes all examples, and returns an empty list.
|
||||
For threshold equal to 0.0:
|
||||
select_examples sorts examples by ngram_overlap_score,
|
||||
and excludes examples with no ngram overlap with input.
|
||||
"""
|
||||
|
||||
@root_validator(pre=True)
|
||||
def check_dependencies(cls, values: Dict) -> Dict:
|
||||
"""Check that valid dependencies exist."""
|
||||
try:
|
||||
from nltk.translate.bleu_score import ( # noqa: disable=F401
|
||||
SmoothingFunction,
|
||||
sentence_bleu,
|
||||
)
|
||||
except ImportError as e:
|
||||
raise ValueError(
|
||||
"Not all the correct dependencies for this ExampleSelect exist"
|
||||
) from e
|
||||
|
||||
return values
|
||||
|
||||
def add_example(self, example: Dict[str, str]) -> None:
|
||||
"""Add new example to list."""
|
||||
self.examples.append(example)
|
||||
|
||||
def select_examples(self, input_variables: Dict[str, str]) -> List[dict]:
|
||||
"""Return list of examples sorted by ngram_overlap_score with input.
|
||||
|
||||
Descending order.
|
||||
Excludes any examples with ngram_overlap_score less than or equal to threshold.
|
||||
"""
|
||||
inputs = list(input_variables.values())
|
||||
examples = []
|
||||
k = len(self.examples)
|
||||
score = [0.0] * k
|
||||
first_prompt_template_key = self.example_prompt.input_variables[0]
|
||||
|
||||
for i in range(k):
|
||||
score[i] = ngram_overlap_score(
|
||||
inputs, [self.examples[i][first_prompt_template_key]]
|
||||
)
|
||||
|
||||
while True:
|
||||
arg_max = np.argmax(score)
|
||||
if (score[arg_max] < self.threshold) or abs(
|
||||
score[arg_max] - self.threshold
|
||||
) < 1e-9:
|
||||
break
|
||||
|
||||
examples.append(self.examples[arg_max])
|
||||
score[arg_max] = self.threshold - 1.0
|
||||
|
||||
return examples
|
||||
@ -0,0 +1,73 @@
|
||||
"""Test functionality related to ngram overlap based selector."""
|
||||
|
||||
import pytest
|
||||
|
||||
from langchain.prompts.example_selector.ngram_overlap import (
|
||||
NGramOverlapExampleSelector,
|
||||
ngram_overlap_score,
|
||||
)
|
||||
from langchain.prompts.prompt import PromptTemplate
|
||||
|
||||
EXAMPLES = [
|
||||
{"input": "See Spot run.", "output": "foo1"},
|
||||
{"input": "My dog barks.", "output": "foo2"},
|
||||
{"input": "Spot can run.", "output": "foo3"},
|
||||
]
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def selector() -> NGramOverlapExampleSelector:
|
||||
"""Get ngram overlap based selector to use in tests."""
|
||||
prompts = PromptTemplate(
|
||||
input_variables=["input", "output"], template="Input: {input}\nOutput: {output}"
|
||||
)
|
||||
selector = NGramOverlapExampleSelector(
|
||||
examples=EXAMPLES,
|
||||
example_prompt=prompts,
|
||||
)
|
||||
return selector
|
||||
|
||||
|
||||
def test_selector_valid(selector: NGramOverlapExampleSelector) -> None:
|
||||
"""Test NGramOverlapExampleSelector can select examples."""
|
||||
sentence = "Spot can run."
|
||||
output = selector.select_examples({"input": sentence})
|
||||
assert output == [EXAMPLES[2], EXAMPLES[0], EXAMPLES[1]]
|
||||
|
||||
|
||||
def test_selector_add_example(selector: NGramOverlapExampleSelector) -> None:
|
||||
"""Test NGramOverlapExampleSelector can add an example."""
|
||||
new_example = {"input": "Spot plays fetch.", "output": "foo4"}
|
||||
selector.add_example(new_example)
|
||||
sentence = "Spot can run."
|
||||
output = selector.select_examples({"input": sentence})
|
||||
assert output == [EXAMPLES[2], EXAMPLES[0]] + [new_example] + [EXAMPLES[1]]
|
||||
|
||||
|
||||
def test_selector_threshold_zero(selector: NGramOverlapExampleSelector) -> None:
|
||||
"""Tests NGramOverlapExampleSelector threshold set to 0.0."""
|
||||
selector.threshold = 0.0
|
||||
sentence = "Spot can run."
|
||||
output = selector.select_examples({"input": sentence})
|
||||
assert output == [EXAMPLES[2], EXAMPLES[0]]
|
||||
|
||||
|
||||
def test_selector_threshold_more_than_one(
|
||||
selector: NGramOverlapExampleSelector,
|
||||
) -> None:
|
||||
"""Tests NGramOverlapExampleSelector threshold greater than 1.0."""
|
||||
selector.threshold = 1.0 + 1e-9
|
||||
sentence = "Spot can run."
|
||||
output = selector.select_examples({"input": sentence})
|
||||
assert output == []
|
||||
|
||||
|
||||
def test_ngram_overlap_score(selector: NGramOverlapExampleSelector) -> None:
|
||||
"""Tests that ngram_overlap_score returns correct values."""
|
||||
selector.threshold = 1.0 + 1e-9
|
||||
none = ngram_overlap_score(["Spot can run."], ["My dog barks."])
|
||||
some = ngram_overlap_score(["Spot can run."], ["See Spot run."])
|
||||
complete = ngram_overlap_score(["Spot can run."], ["Spot can run."])
|
||||
|
||||
check = [abs(none - 0.0) < 1e-9, 0.0 < some < 1.0, abs(complete - 1.0) < 1e-9]
|
||||
assert check == [True, True, True]
|
||||
Loading…
Reference in New Issue