update README + BERGEN pic

naver · Oct 24, 2024 · d261ebe · d261ebe
1 parent 39cfa0e
commit d261ebe
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,23 +1,22 @@
-<img src="https://upload.wikimedia.org/wikipedia/commons/6/62/Night_view_from_Mount_Floyen_-_Bergen%2C_Norway.jpg" width="500">
+<img src="documentation/images/BERGEN.png" width="500">
 
 # BERGEN: A Benchmarking Library for Retrieval-Augmented Generation
 
 [![arXiv](https://img.shields.io/badge/arXiv-2407.01102-b31b1b.svg)](https://arxiv.org/abs/2407.01102)
 [![arXiv](https://img.shields.io/badge/arXiv-2407.01463-b31b1b.svg)](https://arxiv.org/abs/2407.01463)
 [![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
 
-BERGEN (BEnchmarking Retrieval-augmented GENeration) is a library designed to benchmark RAG systems, with a focus on question-answering (QA). It addresses the challenge of inconsistent benchmarking in comparing approaches and understanding the impact of each component in a RAG pipeline.
+BERGEN (BEnchmarking Retrieval-augmented GENeration) is a library designed to benchmark RAG systems with a focus on question-answering (QA). It addresses the challenge of inconsistent benchmarking in comparing approaches and understanding the impact of each component in a RAG pipeline.
 
 ## Key Features
 
 - Easy reproducibility and integration of new datasets and models
-- Support for various retrievers (20+), rerankers(4) , and large language models (20+)
+- Support for various retrievers (20+), rerankers(4) and large language models (20+)
 - Flexible configuration system using YAML files
 - Comprehensive evaluation metrics (*Match, EM, LLMEval*, ... )
 - Support for multilingual experiments
 
-![](documentations/images/teaser_bergen.jpg) 
-
+![](documentation/images/teaser_bergen.jpg) 
 
 For more information and experimental findings, please see:
 - The initial BERGEN paper: https://arxiv.org/abs/2407.01102
@@ -37,7 +36,7 @@ python3 bergen.py retriever="bm25" reranker="minilm6" generator='tinyllama-chat'
 
 ## Installation
 
-Check the [installation guide](documentations/INSTALL.md) for detailed instructions.
+Check the [installation guide](documentation/INSTALL.md) for detailed instructions.
 
 
 ## Usage
@@ -55,11 +54,11 @@ done
 ```
 
 
-To fully configure BERGEN, please read our [configuration guide](documentations/config.md)
+To fully configure BERGEN, please read our [configuration guide](documentation/config.md)
 
 ## Evaluation
 
-Run the evaluation script to calculate LLMEval  metrics and print the results:
+Run the evaluation script to calculate LLMEval metrics and print the results:
 
 ```bash
 python3 eval.py --experiments_folder experiments/ --llm_batch_size 16 --split 'dev' --llm vllm_SOLAR-107B
@@ -68,7 +67,7 @@ python3 eval.py --experiments_folder experiments/ --llm_batch_size 16 --split 'd
 python print_results.py --folder experiments/ --format=tiny
 ```
 
-For more evaluation options and details, refer to the [Evaluation section](documentations/evaluations.md) in the full documentation.
+For more evaluation options and details, refer to the [Evaluation section](documentation/evaluations.md) in the complete documentation.
 
 ## RAG Baselines
 Bergen provides results for several models and many datasets aiming to **provide strong baselines**. On the important datasets for RAG, the match metric is given by this table (see more in our paper): 
@@ -83,7 +82,7 @@ Solar-10.7B   | 76.2 | 70.2 | 92.8 | 71.2 |  53.9|
 
 ## Multilingual Experiments
 
-Refer to our [multilingual RAG guide](documentations/multilingual.md) for running experiments with multilingual user queries and/or multilingual Wikipedia as a datastore.
+Refer to our [multilingual RAG guide](documentation/multilingual.md) for running experiments with multilingual user queries and/or multilingual Wikipedia as a datastore.
 
 
 ## Training
@@ -96,7 +95,7 @@ python3 bergen.py retriever="bm25" reranker="minilm6" generator='tinyllama-chat'
 
 ## Extensions
 
-For adding new datasets, models, or configuring prompts, see our [reference guide](documentations/extensions.md).
+To add new datasets and models, or configure prompts, see our [reference guide](/extensions.md).
 
 
 ## Cite

diff --git a/documentations/INSTALL.md → documentation/INSTALL.md b/documentations/INSTALL.md → documentation/INSTALL.md
diff --git a/documentations/config.md → documentation/config.md b/documentations/config.md → documentation/config.md
diff --git a/documentations/evaluations.md → documentation/evaluations.md b/documentations/evaluations.md → documentation/evaluations.md
diff --git a/documentations/extensions.md → documentation/extensions.md b/documentations/extensions.md → documentation/extensions.md
diff --git a/documentation/images/BERGEN.png b/documentation/images/BERGEN.png
diff --git a/documentations/images/teaser_bergen.jpg → documentation/images/teaser_bergen.jpg b/documentations/images/teaser_bergen.jpg → documentation/images/teaser_bergen.jpg
diff --git a/documentations/indexing.md → documentation/indexing.md b/documentations/indexing.md → documentation/indexing.md
diff --git a/documentations/multilingual.md → documentation/multilingual.md b/documentations/multilingual.md → documentation/multilingual.md
diff --git a/documentations/training.md → documentation/training.md b/documentations/training.md → documentation/training.md