Provence is a lightweight
context pruning model
for retrieval-augmented generation, particularly
optimized for question answering
. Given a user question and a retrieved passage, Provence
removes sentences from the passage that are not relevant to the user question
. This
speeds up generation
and
reduces context noise
, in a plug-and-play manner
for any LLM
. More details about the model can be found in the
paper
.
from transformers import AutoModel
provence = AutoModel.from_pretrained("naver/provence-reranker-debertav3-v1", trust_remote_code=True)
context = "Shepherd’s pie. History. In early cookery books, the dish was a means of using leftover roasted meat of any kind, and the pie dish was lined on the sides and bottom with mashed potato, as well as having a mashed potato crust on top. Variations and similar dishes. Other potato-topped pies include: The modern ”Cumberland pie” is a version with either beef or lamb and a layer of bread- crumbs and cheese on top. In medieval times, and modern-day Cumbria, the pastry crust had a filling of meat with fruits and spices.. In Quebec, a varia- tion on the cottage pie is called ”Paˆte ́ chinois”. It is made with ground beef on the bottom layer, canned corn in the middle, and mashed potato on top.. The ”shepherdess pie” is a vegetarian version made without meat, or a vegan version made without meat and dairy.. In the Netherlands, a very similar dish called ”philosopher’s stew” () often adds ingredients like beans, apples, prunes, or apple sauce.. In Brazil, a dish called in refers to the fact that a manioc puree hides a layer of sun-dried meat."
question = 'What goes on the bottom of Shepherd’s pie?'
provence_output = provence.process(question, context)
# print(f"Provence Output: {provence_output}")# Provence Output: {'reranking_score': 3.022725, pruned_context': 'In early cookery books, the dish was a means of using leftover roasted meat of any kind, and the pie dish was lined on the sides and bottom with mashed potato, as well as having a mashed potato crust on top.']]
You can also pass a list of questions and a list of lists of contexts (multiple contexts per question to be pruned) for batched processing.
Setting
always_select_title=True
will keep the first sentence "Shepherd’s pie". This is especially useful for Wikipedia articles where the title is often needed to understand the context.
More details on how the title is defined are given below.
provence_output = provence.process(question, context, always_select_title=True)
# print(f"Provence Output: {provence_output}")# Provence Output: {'reranking_score': 3.022725, pruned_context': 'Shepherd’s pie. In early cookery books, the dish was a means of using leftover roasted meat of any kind, and the pie dish was lined on the sides and bottom with mashed potato, as well as having a mashed potato crust on top.']]
Model interface
Interface of the
process
function:
question
:
Union[List[str], str]
: an input question (str) or a list of input questions (for batched processing)
context
:
Union[List[List[str]], str]
: context(s) to be pruned. This can be either a single string (in case of a singe str question), or a list of lists contexts (a list of contexts per question), with
len(contexts)
equal to
len(questions)
title
:
Optional[Union[List[List[str]], str]]
,
default: “first_sentence”
: an optional argument for defining titles. If
title=first_sentence
, then the first sentence of each context is assumed to be the title. If
title=None
, then it is assumed that no titles are provided. Titles can be also passed as a list of lists of str, i.e. titles shaped the same way as contexts. Titles are only used if
always_select_title=True
.
threshold
(float, $ \in [0, 1]$, default 0.1)
: which threshold to use for context pruning. We recommend 0.1 for more conservative pruning (no performance drop or lowest performance drops) and 0.5 for higher compression, but this value can be further tuned to meet the specific use case requirements.
always_select_title
(bool, default: True)
: if True, the first sentence (title) will be included into the selection each time the model select a non-empty selection of sentences. This is important, e.g., for Wikipedia passages, to provide proper contextualization for the next sentences.
batch_size
(int, default: 32)
reorder
(bool, default: False)
: if True, the provided contexts for each question will be reordered according to the computed question-passage relevance scores. If False, the original user-provided order of contexts will be preserved.
top_k
(int, default: 5)
: if
reorder=True
, specifies the number of top-ranked passages to keep for each question.
enable_warnings
(bool, default: True)
: whether the user prefers the warning about model usage to be printed, e.g. too long contexts or questions.
Model features
Provence encodes all sentences in the passage together
: this enables capturing of coreferences between sentences and provides more accurate context pruning.
Provence automatically detects the number of sentences to keep
, based on a threshold. We found that the default value of a threshold works well across various domains, but the threshold can be adjusted further to better meet the particular use case needs.
Provence is robust to various domains
, being trained on a combination of diverse MS Marco and Natural Questions data.
Provence works out-of-the-box with any LLM
.
Model Details
Input: user question (e.g., a sentence) + retrieved context passage (e.g., a paragraph)
Output: pruned context passage, i.e., irrelevant sentences are removed + relevance score (can be used for reranking)
Model Architecture: The model was initialized from
DeBERTav3-reranker
and finetuned with two objectives: (1) output a binary mask which can be used to prune irrelevant sentences; and (2) preserve initial reranking capabilities.
Training data: MS Marco (document) + NQ training sets, with synthetic silver labelling of which sentences to keep, produced using
LLama-3-8B
.
Languages covered: English
Context length: 512 tokens (similar to the pretrained DeBERTa model)
Evaluation: we evaluate Provence on 7 datasets from various domains: Wikipedia, biomedical data, course syllabi, and news. We find that Provence is able to prune irrelevant sentences with little-to-no drop in performance, in all domains, and outperforms existing baselines on the Pareto front (top right corners of the plots).
provence-reranker-debertav3-v1 huggingface.co is an AI model on huggingface.co that provides provence-reranker-debertav3-v1's model effect (), which can be used instantly with this naver provence-reranker-debertav3-v1 model. huggingface.co supports a free trial of the provence-reranker-debertav3-v1 model, and also provides paid use of the provence-reranker-debertav3-v1. Support call provence-reranker-debertav3-v1 model through api, including Node.js, Python, http.
provence-reranker-debertav3-v1 huggingface.co is an online trial and call api platform, which integrates provence-reranker-debertav3-v1's modeling effects, including api services, and provides a free online trial of provence-reranker-debertav3-v1, you can try provence-reranker-debertav3-v1 online for free by clicking the link below.
naver provence-reranker-debertav3-v1 online free url in huggingface.co:
provence-reranker-debertav3-v1 is an open source model from GitHub that offers a free installation service, and any user can find provence-reranker-debertav3-v1 on GitHub to install. At the same time, huggingface.co provides the effect of provence-reranker-debertav3-v1 install, users can directly use provence-reranker-debertav3-v1 installed effect in huggingface.co for debugging and trial. It also supports api for free installation.
provence-reranker-debertav3-v1 install url in huggingface.co: