deepset-ai · agnieszka-m · Jun 3, 2022 · May 31, 2022 · May 31, 2022
diff --git a/docs/_src/api/api/pipelines.md b/docs/_src/api/api/pipelines.md
@@ -425,7 +425,7 @@ E.g. you can call execute_eval_run() multiple times with different retrievers in
 
 - `index_pipeline`: The indexing pipeline to use.
 - `query_pipeline`: The query pipeline to evaluate.
-- `evaluation_set_labels`: The labels to evaluate on forming an evalution set.
+- `evaluation_set_labels`: The labels to evaluate on forming an evaluation set.
 - `corpus_file_paths`: The files to be indexed and searched during evaluation forming a corpus.
 - `experiment_name`: The name of the experiment
 - `experiment_run_name`: The name of the experiment run

diff --git a/docs/_src/tutorials/tutorials/1.md b/docs/_src/tutorials/tutorials/1.md
@@ -139,7 +139,7 @@ print(docs[:3])
 document_store.write_documents(docs)
 ```
 
-## Initalize Retriever, Reader,  & Pipeline
+## Initialize Retriever, Reader & Pipeline
 
 ### Retriever
 

diff --git a/docs/_src/tutorials/tutorials/12.md b/docs/_src/tutorials/tutorials/12.md
@@ -76,7 +76,7 @@ docs = convert_files_to_docs(dir_path=doc_dir, clean_func=clean_wiki_text, split
 document_store.write_documents(docs)
 ```
 
-### Initalize Retriever and Reader/Generator
+### Initialize Retriever and Reader/Generator
 
 #### Retriever
 

diff --git a/docs/_src/tutorials/tutorials/15.md b/docs/_src/tutorials/tutorials/15.md
@@ -130,7 +130,7 @@ print(tables[0].content)
 print(tables[0].meta)
 ```
 
-## Initalize Retriever, Reader, & Pipeline
+## Initialize Retriever, Reader & Pipeline
 
 ### Retriever
 

diff --git a/docs/_src/tutorials/tutorials/3.md b/docs/_src/tutorials/tutorials/3.md
@@ -98,7 +98,7 @@ print(docs[:3])
 document_store.write_documents(docs)
 ```
 
-## Initalize Retriever, Reader & Pipeline
+## Initialize Retriever, Reader & Pipeline
 
 ### Retriever
 

diff --git a/docs/_src/tutorials/tutorials/5.md b/docs/_src/tutorials/tutorials/5.md
@@ -180,7 +180,7 @@ Here we evaluate retriever and reader in open domain fashion on the full corpus
 correctly retrieved if it contains the gold answer string within it. The reader is evaluated based purely on the
 predicted answer string, regardless of which document this came from and the position of the extracted span.
 
-The generation of predictions is seperated from the calculation of metrics. This allows you to run the computation-heavy model predictions only once and then iterate flexibly on the metrics or reports you want to generate.
+The generation of predictions is separated from the calculation of metrics. This allows you to run the computation-heavy model predictions only once and then iterate flexibly on the metrics or reports you want to generate.
 
 
 

diff --git a/docs/_src/tutorials/tutorials/6.md b/docs/_src/tutorials/tutorials/6.md
@@ -45,7 +45,7 @@ Recent work suggests that dual encoders work better, likely because they can dea
 ### "Dense Passage Retrieval"
 
 In this Tutorial, we want to highlight one "Dense Dual-Encoder" called Dense Passage Retriever. 
-It was introdoced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
+It was introduced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
 
 Original Abstract: 
 
@@ -147,7 +147,7 @@ docs = convert_files_to_docs(dir_path=doc_dir, clean_func=clean_wiki_text, split
 document_store.write_documents(docs)
 ```
 
-### Initalize Retriever, Reader & Pipeline
+### Initialize Retriever, Reader & Pipeline
 
 #### Retriever
 

diff --git a/docs/_src/tutorials/tutorials/8.md b/docs/_src/tutorials/tutorials/8.md
@@ -66,7 +66,7 @@ fetch_archive_from_http(url=s3_url, output_dir=doc_dir)
 Haystack's converter classes are designed to help you turn files on your computer into the documents
 that can be processed by the Haystack pipeline.
 There are file converters for txt, pdf, docx files as well as a converter that is powered by Apache Tika.
-The parameter `valid_langugages` does not convert files to the target language, but checks if the conversion worked as expected.
+The parameter `valid_languages` does not convert files to the target language, but checks if the conversion worked as expected.
 
 
 ```python

diff --git a/docs/v0.10.0/_src/tutorials/tutorials/1.md b/docs/v0.10.0/_src/tutorials/tutorials/1.md
@@ -142,7 +142,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Pipeline
+## Initialize Retriever, Reader & Pipeline
 
 ### Retriever
 

diff --git a/docs/v0.10.0/_src/tutorials/tutorials/12.md b/docs/v0.10.0/_src/tutorials/tutorials/12.md
@@ -73,7 +73,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever and Reader/Generator
+### Initialize Retriever and Reader/Generator
 
 #### Retriever
 

diff --git a/docs/v0.10.0/_src/tutorials/tutorials/3.md b/docs/v0.10.0/_src/tutorials/tutorials/3.md
@@ -101,7 +101,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader & Pipeline
+## Initialize Retriever, Reader & Pipeline
 
 ### Retriever
 

diff --git a/docs/v0.10.0/_src/tutorials/tutorials/6.md b/docs/v0.10.0/_src/tutorials/tutorials/6.md
@@ -45,7 +45,7 @@ Recent work suggests that dual encoders work better, likely because they can dea
 ### "Dense Passage Retrieval"
 
 In this Tutorial, we want to highlight one "Dense Dual-Encoder" called Dense Passage Retriever. 
-It was introdoced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
+It was introduced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
 
 Original Abstract: 
 
@@ -145,7 +145,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever, Reader & Pipeline
+### Initialize Retriever, Reader & Pipeline
 
 #### Retriever
 

diff --git a/docs/v0.4.0/_src/tutorials/tutorials/1.md b/docs/v0.4.0/_src/tutorials/tutorials/1.md
@@ -127,7 +127,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.4.0/_src/tutorials/tutorials/3.md b/docs/v0.4.0/_src/tutorials/tutorials/3.md
@@ -87,7 +87,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.4.0/_src/tutorials/tutorials/6.md b/docs/v0.4.0/_src/tutorials/tutorials/6.md
@@ -45,7 +45,7 @@ Recent work suggests that dual encoders work better, likely because they can dea
 ### "Dense Passage Retrieval"
 
 In this Tutorial, we want to highlight one "Dense Dual-Encoder" called Dense Passage Retriever. 
-It was introdoced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
+It was introduced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
 
 Original Abstract: 
 
@@ -124,7 +124,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever, Reader,  & Finder
+### Initialize Retriever, Reader & Finder
 
 #### Retriever
 

diff --git a/docs/v0.5.0/_src/tutorials/tutorials/1.md b/docs/v0.5.0/_src/tutorials/tutorials/1.md
@@ -127,7 +127,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.5.0/_src/tutorials/tutorials/3.md b/docs/v0.5.0/_src/tutorials/tutorials/3.md
@@ -87,7 +87,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.5.0/_src/tutorials/tutorials/6.md b/docs/v0.5.0/_src/tutorials/tutorials/6.md
@@ -45,7 +45,7 @@ Recent work suggests that dual encoders work better, likely because they can dea
 ### "Dense Passage Retrieval"
 
 In this Tutorial, we want to highlight one "Dense Dual-Encoder" called Dense Passage Retriever. 
-It was introdoced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
+It was introduced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
 
 Original Abstract: 
 
@@ -124,7 +124,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever, Reader,  & Finder
+### Initialize Retriever, Reader & Finder
 
 #### Retriever
 

diff --git a/docs/v0.6.0/_src/tutorials/tutorials/1.md b/docs/v0.6.0/_src/tutorials/tutorials/1.md
@@ -129,7 +129,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.6.0/_src/tutorials/tutorials/3.md b/docs/v0.6.0/_src/tutorials/tutorials/3.md
@@ -89,7 +89,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.6.0/_src/tutorials/tutorials/6.md b/docs/v0.6.0/_src/tutorials/tutorials/6.md
@@ -45,7 +45,7 @@ Recent work suggests that dual encoders work better, likely because they can dea
 ### "Dense Passage Retrieval"
 
 In this Tutorial, we want to highlight one "Dense Dual-Encoder" called Dense Passage Retriever. 
-It was introdoced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
+It was introduced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
 
 Original Abstract: 
 
@@ -129,7 +129,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever, Reader,  & Finder
+### Initialize Retriever, Reader & Finder
 
 #### Retriever
 

diff --git a/docs/v0.7.0/_src/tutorials/tutorials/1.md b/docs/v0.7.0/_src/tutorials/tutorials/1.md
@@ -142,7 +142,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.7.0/_src/tutorials/tutorials/3.md b/docs/v0.7.0/_src/tutorials/tutorials/3.md
@@ -103,7 +103,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.7.0/_src/tutorials/tutorials/6.md b/docs/v0.7.0/_src/tutorials/tutorials/6.md
@@ -45,7 +45,7 @@ Recent work suggests that dual encoders work better, likely because they can dea
 ### "Dense Passage Retrieval"
 
 In this Tutorial, we want to highlight one "Dense Dual-Encoder" called Dense Passage Retriever. 
-It was introdoced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
+It was introduced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
 
 Original Abstract: 
 
@@ -129,7 +129,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever, Reader,  & Finder
+### Initialize Retriever, Reader & Finder
 
 #### Retriever
 

diff --git a/docs/v0.8.0/_src/tutorials/tutorials/1.md b/docs/v0.8.0/_src/tutorials/tutorials/1.md
@@ -140,7 +140,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.8.0/_src/tutorials/tutorials/3.md b/docs/v0.8.0/_src/tutorials/tutorials/3.md
@@ -101,7 +101,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.8.0/_src/tutorials/tutorials/6.md b/docs/v0.8.0/_src/tutorials/tutorials/6.md
@@ -45,7 +45,7 @@ Recent work suggests that dual encoders work better, likely because they can dea
 ### "Dense Passage Retrieval"
 
 In this Tutorial, we want to highlight one "Dense Dual-Encoder" called Dense Passage Retriever. 
-It was introdoced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
+It was introduced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
 
 Original Abstract: 
 
@@ -127,7 +127,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever, Reader,  & Finder
+### Initialize Retriever, Reader & Finder
 
 #### Retriever
 

diff --git a/docs/v0.9.0/_src/tutorials/tutorials/1.md b/docs/v0.9.0/_src/tutorials/tutorials/1.md
@@ -142,7 +142,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.9.0/_src/tutorials/tutorials/12.md b/docs/v0.9.0/_src/tutorials/tutorials/12.md
@@ -73,7 +73,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever and Reader/Generator
+### Initialize Retriever and Reader/Generator
 
 #### Retriever
 

diff --git a/docs/v0.9.0/_src/tutorials/tutorials/3.md b/docs/v0.9.0/_src/tutorials/tutorials/3.md
@@ -102,7 +102,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Finder
+## Initialize Retriever, Reader & Finder
 
 ### Retriever
 

diff --git a/docs/v0.9.0/_src/tutorials/tutorials/6.md b/docs/v0.9.0/_src/tutorials/tutorials/6.md
@@ -45,7 +45,7 @@ Recent work suggests that dual encoders work better, likely because they can dea
 ### "Dense Passage Retrieval"
 
 In this Tutorial, we want to highlight one "Dense Dual-Encoder" called Dense Passage Retriever. 
-It was introdoced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
+It was introduced by Karpukhin et al. (2020, https://arxiv.org/abs/2004.04906. 
 
 Original Abstract: 
 
@@ -146,7 +146,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever, Reader,  & Finder
+### Initialize Retriever, Reader & Finder
 
 #### Retriever
 

diff --git a/docs/v1.0.0/_src/api/api/primitives.md b/docs/v1.0.0/_src/api/api/primitives.md
@@ -280,10 +280,10 @@ The DataFrames have the following schema:
 - context (answers only): the surrounding context of the answer within the document
 - offsets_in_document (answers only): the position or offsets within the document the answer was found
 - gold_answers (answers only): the answers to be given
-- gold_offsets_in_documents (answers only): the positon or offsets of the gold answer within the document
+- gold_offsets_in_documents (answers only): the position or offsets of the gold answer within the document
 - exact_match (answers only): metric depicting if the answer exactly matches the gold label
 - f1 (answers only): metric depicting how well the answer overlaps with the gold label on token basis
-- sas (answers only, optional): metric depciting how well the answer matches the gold label on a semantic basis
+- sas (answers only, optional): metric depicting how well the answer matches the gold label on a semantic basis
 
 **Arguments**:
 

diff --git a/docs/v1.0.0/_src/tutorials/tutorials/1.md b/docs/v1.0.0/_src/tutorials/tutorials/1.md
@@ -141,7 +141,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader,  & Pipeline
+## Initialize Retriever, Reader & Pipeline
 
 ### Retriever
 

diff --git a/docs/v1.0.0/_src/tutorials/tutorials/12.md b/docs/v1.0.0/_src/tutorials/tutorials/12.md
@@ -75,7 +75,7 @@ dicts = convert_files_to_dicts(dir_path=doc_dir, clean_func=clean_wiki_text, spl
 document_store.write_documents(dicts)
 ```
 
-### Initalize Retriever and Reader/Generator
+### Initialize Retriever and Reader/Generator
 
 #### Retriever
 

diff --git a/docs/v1.0.0/_src/tutorials/tutorials/15.md b/docs/v1.0.0/_src/tutorials/tutorials/15.md
@@ -136,7 +136,7 @@ print(tables[0].content)
 print(tables[0].meta)
 ```
 
-## Initalize Retriever, Reader, & Pipeline
+## Initialize Retriever, Reader & Pipeline
 
 ### Retriever
 

diff --git a/docs/v1.0.0/_src/tutorials/tutorials/3.md b/docs/v1.0.0/_src/tutorials/tutorials/3.md
@@ -100,7 +100,7 @@ print(dicts[:3])
 document_store.write_documents(dicts)
 ```
 
-## Initalize Retriever, Reader & Pipeline
+## Initialize Retriever, Reader & Pipeline
 
 ### Retriever