Module base

BaseReader Objects

class BaseReader(BaseComponent)

run_batch

| run_batch(query_doc_list: List[Dict], top_k: Optional[int] = None)

A unoptimized implementation of running Reader queries in batch

timing

| timing(fn, attr_name)

Wrapper method used to time functions.

Module farm

FARMReader Objects

class FARMReader(BaseReader)

Transformer based model for extractive Question Answering using the FARM framework (https://github.com/deepset-ai/FARM). While the underlying model can vary (BERT, Roberta, DistilBERT, ...), the interface remains the same.

| With a FARMReader, you can:

directly get predictions via predict()
fine-tune the model on QA data via train()

init

| __init__(model_name_or_path: Union[str, Path], model_version: Optional[str] = None, context_window_size: int = 150, batch_size: int = 50, use_gpu: bool = True, no_ans_boost: float = 0.0, return_no_answer: bool = False, top_k: int = 10, top_k_per_candidate: int = 3, top_k_per_sample: int = 1, num_processes: Optional[int] = None, max_seq_len: int = 256, doc_stride: int = 128, progress_bar: bool = True, duplicate_filtering: int = 0, use_confidence_scores: bool = True)

Arguments:

model_name_or_path: Directory of a saved model or the name of a public model e.g. 'bert-base-cased', 'deepset/bert-base-cased-squad2', 'deepset/bert-base-cased-squad2', 'distilbert-base-uncased-distilled-squad'. See https://huggingface.co/models for full list of available models.
model_version: The version of model to use from the HuggingFace model hub. Can be tag name, branch name, or commit hash.
context_window_size: The size, in characters, of the window around the answer span that is used when displaying the context around the answer.
batch_size: Number of samples the model receives in one batch for inference. Memory consumption is much lower in inference mode. Recommendation: Increase the batch size to a value so only a single batch is used.
use_gpu: Whether to use GPU (if available)
no_ans_boost: How much the no_answer logit is boosted/increased. If set to 0 (default), the no_answer logit is not changed. If a negative number, there is a lower chance of "no_answer" being predicted. If a positive number, there is an increased chance of "no_answer"
return_no_answer: Whether to include no_answer predictions in the results.
top_k: The maximum number of answers to return
top_k_per_candidate: How many answers to extract for each candidate doc that is coming from the retriever (might be a long text). Note that this is not the number of "final answers" you will receive (see top_k in FARMReader.predict() or Finder.get_answers() for that) and that FARM includes no_answer in the sorted list of predictions.
top_k_per_sample: How many answers to extract from each small text passage that the model can process at once (one "candidate doc" is usually split into many smaller "passages"). You usually want a very small value here, as it slows down inference and you don't gain much of quality by having multiple answers from one passage. Note that this is not the number of "final answers" you will receive (see top_k in FARMReader.predict() or Finder.get_answers() for that) and that FARM includes no_answer in the sorted list of predictions.
num_processes: The number of processes for multiprocessing.Pool. Set to value of 0 to disable multiprocessing. Set to None to let Inferencer determine optimum number. If you want to debug the Language Model, you might need to disable multiprocessing!
max_seq_len: Max sequence length of one input text for the model
doc_stride: Length of striding window for splitting long texts (used if len(text) > max_seq_len)
progress_bar: Whether to show a tqdm progress bar or not. Can be helpful to disable in production deployments to keep the logs clean.
duplicate_filtering: Answers are filtered based on their position. Both start and end position of the answers are considered. The higher the value, answers that are more apart are filtered out. 0 corresponds to exact duplicates. -1 turns off duplicate removal.

train

| train(data_dir: str, train_filename: str, dev_filename: Optional[str] = None, test_filename: Optional[str] = None, use_gpu: Optional[bool] = None, batch_size: int = 10, n_epochs: int = 2, learning_rate: float = 1e-5, max_seq_len: Optional[int] = None, warmup_proportion: float = 0.2, dev_split: float = 0, evaluate_every: int = 300, save_dir: Optional[str] = None, num_processes: Optional[int] = None, use_amp: str = None)

Fine-tune a model on a QA dataset. Options:

Take a plain language model (e.g. bert-base-cased) and train it for QA (e.g. on SQuAD data)
Take a QA model (e.g. deepset/bert-base-cased-squad2) and fine-tune it for your domain (e.g. using your labels collected via the haystack annotation tool)

Arguments:

data_dir: Path to directory containing your training data in SQuAD style
train_filename: Filename of training data
dev_filename: Filename of dev / eval data
test_filename: Filename of test data
dev_split: Instead of specifying a dev_filename, you can also specify a ratio (e.g. 0.1) here that gets split off from training data for eval.
use_gpu: Whether to use GPU (if available)
batch_size: Number of samples the model receives in one batch for training
n_epochs: Number of iterations on the whole training data set
learning_rate: Learning rate of the optimizer
max_seq_len: Maximum text length (in tokens). Everything longer gets cut down.
warmup_proportion: Proportion of training steps until maximum learning rate is reached. Until that point LR is increasing linearly. After that it's decreasing again linearly. Options for different schedules are available in FARM.
evaluate_every: Evaluate the model every X steps on the hold-out eval dataset
save_dir: Path to store the final model
num_processes: The number of processes for multiprocessing.Pool during preprocessing. Set to value of 1 to disable multiprocessing. When set to 1, you cannot split away a dev set from train set. Set to None to use all CPU cores minus one.
use_amp: Optimization level of NVIDIA's automatic mixed precision (AMP). The higher the level, the faster the model. Available options: None (Don't use AMP) "O0" (Normal FP32 training) "O1" (Mixed Precision => Recommended) "O2" (Almost FP16) "O3" (Pure FP16). See details on: https://nvidia.github.io/apex/amp.html

Returns:

None

update_parameters

| update_parameters(context_window_size: Optional[int] = None, no_ans_boost: Optional[float] = None, return_no_answer: Optional[bool] = None, max_seq_len: Optional[int] = None, doc_stride: Optional[int] = None)

Hot update parameters of a loaded Reader. It may not to be safe when processing concurrent requests.

save

| save(directory: Path)

Saves the Reader model so that it can be reused at a later point in time.

Arguments:

directory: Directory where the Reader model should be saved

predict_batch

| predict_batch(query_doc_list: List[dict], top_k: int = None, batch_size: int = None)

Use loaded QA model to find answers for a list of queries in each query's supplied list of Document.

Returns list of dictionaries containing answers sorted by (desc.) score

Arguments:

query_doc_list: List of dictionaries containing queries with their retrieved documents
top_k: The maximum number of answers to return for each query
batch_size: Number of samples the model receives in one batch for inference

Returns:

List of dictionaries containing query and answers

predict

| predict(query: str, documents: List[Document], top_k: Optional[int] = None)

Use loaded QA model to find answers for a query in the supplied list of Document.

Returns dictionaries containing answers sorted by (desc.) score. Example:

|{
   |    'query': 'Who is the father of Arya Stark?',
   |    'answers':[
   |                 {'answer': 'Eddard,',
   |                 'context': " She travels with her father, Eddard, to King's Landing when he is ",
   |                 'offset_answer_start': 147,
   |                 'offset_answer_end': 154,
   |                 'score': 0.9787139466668613,
   |                 'document_id': '1337'
   |                 },...
   |              ]
   |}

Arguments:

query: Query string
documents: List of Document in which to search for the answer
top_k: The maximum number of answers to return

Returns:

Dict containing query and answers

eval_on_file

| eval_on_file(data_dir: str, test_filename: str, device: Optional[str] = None)

Performs evaluation on a SQuAD-formatted file. Returns a dict containing the following metrics: - "EM": exact match score - "f1": F1-Score - "top_n_accuracy": Proportion of predicted answers that overlap with correct answer

Arguments:

data_dir: The directory in which the test set can be found :type data_dir: Path or str
test_filename: The name of the file containing the test data in SQuAD format. :type test_filename: str
device: The device on which the tensors should be processed. Choose from "cpu" and "cuda" or use the Reader's device by default. :type device: str

eval

| eval(document_store: BaseDocumentStore, device: Optional[str] = None, label_index: str = "label", doc_index: str = "eval_document", label_origin: str = "gold_label", calibrate_conf_scores: bool = False)

Performs evaluation on evaluation documents in the DocumentStore. Returns a dict containing the following metrics: - "EM": Proportion of exact matches of predicted answers with their corresponding correct answers - "f1": Average overlap between predicted answers and their corresponding correct answers - "top_n_accuracy": Proportion of predicted answers that overlap with correct answer

Arguments:

document_store: DocumentStore containing the evaluation documents
device: The device on which the tensors should be processed. Choose from "cpu" and "cuda" or use the Reader's device by default.
label_index: Index/Table name where labeled questions are stored
doc_index: Index/Table name where documents that are used for evaluation are stored
label_origin: Field name where the gold labels are stored
calibrate_conf_scores: Whether to calibrate the temperature for temperature scaling of the confidence scores

calibrate_confidence_scores

| calibrate_confidence_scores(document_store: BaseDocumentStore, device: Optional[str] = None, label_index: str = "label", doc_index: str = "eval_document", label_origin: str = "gold_label")

Calibrates confidence scores on evaluation documents in the DocumentStore.

Arguments:

document_store: DocumentStore containing the evaluation documents
device: The device on which the tensors should be processed. Choose from "cpu" and "cuda" or use the Reader's device by default.
label_index: Index/Table name where labeled questions are stored
doc_index: Index/Table name where documents that are used for evaluation are stored
label_origin: Field name where the gold labels are stored

predict_on_texts

| predict_on_texts(question: str, texts: List[str], top_k: Optional[int] = None)

Use loaded QA model to find answers for a question in the supplied list of Document. Returns dictionaries containing answers sorted by (desc.) score. Example:

|{
   |    'question': 'Who is the father of Arya Stark?',
   |    'answers':[
   |                 {'answer': 'Eddard,',
   |                 'context': " She travels with her father, Eddard, to King's Landing when he is ",
   |                 'offset_answer_start': 147,
   |                 'offset_answer_end': 154,
   |                 'score': 0.9787139466668613,
   |                 'document_id': '1337'
   |                 },...
   |              ]
   |}

Arguments:

question: Question string
documents: List of documents as string type
top_k: The maximum number of answers to return

Returns:

Dict containing question and answers

convert_to_onnx

| @classmethod
 | convert_to_onnx(cls, model_name: str, output_path: Path, convert_to_float16: bool = False, quantize: bool = False, task_type: str = "question_answering", opset_version: int = 11)

Convert a PyTorch BERT model to ONNX format and write to ./onnx-export dir. The converted ONNX model can be loaded with in the FARMReader using the export path as model_name_or_path param.

Usage:

`from haystack.reader.farm import FARMReader
from pathlib import Path
onnx_model_path = Path(&quot;roberta-onnx-model&quot;)
FARMReader.convert_to_onnx(model_name=&quot;deepset/bert-base-cased-squad2&quot;, output_path=onnx_model_path)
reader = FARMReader(onnx_model_path)`

Arguments:

model_name: transformers model name
output_path: Path to output the converted model
convert_to_float16: Many models use float32 precision by default. With the half precision of float16, inference is faster on Nvidia GPUs with Tensor core like T4 or V100. On older GPUs, float32 could still be be more performant.
quantize: convert floating point number to integers
task_type: Type of task for the model. Available options: "question_answering" or "embeddings".
opset_version: ONNX opset version

Module transformers

TransformersReader Objects

class TransformersReader(BaseReader)

Transformer based model for extractive Question Answering using the HuggingFace's transformers framework (https://github.com/huggingface/transformers). While the underlying model can vary (BERT, Roberta, DistilBERT ...), the interface remains the same. With this reader, you can directly get predictions via predict()

init

| __init__(model_name_or_path: str = "distilbert-base-uncased-distilled-squad", model_version: Optional[str] = None, tokenizer: Optional[str] = None, context_window_size: int = 70, use_gpu: int = 0, top_k: int = 10, top_k_per_candidate: int = 4, return_no_answers: bool = True, max_seq_len: int = 256, doc_stride: int = 128)

Load a QA model from Transformers. Available models include:

'distilbert-base-uncased-distilled-squad`'
'bert-large-cased-whole-word-masking-finetuned-squad'
'bert-large-uncased-whole-word-masking-finetuned-squad'

See https://huggingface.co/models for full list of available QA models

Arguments:

model_name_or_path: Directory of a saved model or the name of a public model e.g. 'bert-base-cased', 'deepset/bert-base-cased-squad2', 'deepset/bert-base-cased-squad2', 'distilbert-base-uncased-distilled-squad'. See https://huggingface.co/models for full list of available models.
model_version: The version of model to use from the HuggingFace model hub. Can be tag name, branch name, or commit hash.
tokenizer: Name of the tokenizer (usually the same as model)
context_window_size: Num of chars (before and after the answer) to return as "context" for each answer. The context usually helps users to understand if the answer really makes sense.
use_gpu: If < 0, then use cpu. If >= 0, this is the ordinal of the gpu to use
top_k: The maximum number of answers to return
top_k_per_candidate: How many answers to extract for each candidate doc that is coming from the retriever (might be a long text). Note that this is not the number of "final answers" you will receive (see top_k in TransformersReader.predict() or Finder.get_answers() for that) and that no_answer can be included in the sorted list of predictions.
return_no_answers: If True, the HuggingFace Transformers model could return a "no_answer" (i.e. when there is an unanswerable question) If False, it cannot return a "no_answer". Note that no_answer_boost is unfortunately not available with TransformersReader. If you would like to set no_answer_boost, use a FARMReader.
max_seq_len: max sequence length of one input text for the model
doc_stride: length of striding window for splitting long texts (used if len(text) > max_seq_len)

predict

| predict(query: str, documents: List[Document], top_k: Optional[int] = None)

Use loaded QA model to find answers for a query in the supplied list of Document.

Returns dictionaries containing answers sorted by (desc.) score. Example:

|{
   |    'query': 'Who is the father of Arya Stark?',
   |    'answers':[
   |                 {'answer': 'Eddard,',
   |                 'context': " She travels with her father, Eddard, to King's Landing when he is ",
   |                 'offset_answer_start': 147,
   |                 'offset_answer_end': 154,
   |                 'score': 0.9787139466668613,
   |                 'document_id': '1337'
   |                 },...
   |              ]
   |}

Arguments:

query: Query string
documents: List of Document in which to search for the answer
top_k: The maximum number of answers to return

Returns:

Dict containing query and answers

Stars

2435

Edit on GitHub

BaseReader Objects
FARMReader Objects
TransformersReader Objects