RAGLAB: A Modular and Research-Oriented Unified Framework for Retrieval-Augmented Generation

• RAGLAB is a modular, research-oriented open-source framework for Retrieval-Augmented Generation (RAG) algorithms. It offers reproductions of 6 existing RAG algorithms and a comprehensive evaluation system with 10 benchmark datasets, enabling fair comparisons between RAG algorithms and easy expansion for efficient development of new algorithms, datasets, and evaluation metrics.

🌟Features

• Comprehensive RAG Ecosystem: Supports the entire RAG pipeline from data collection and training to auto-evaluation.
• Advanced Algorithm Implementations: Reproduces 6 state-of-the-art RAG algorithms, with an easy-to-extend framework for developing new algorithms.
• Interact Mode & Evaluation Mode: Interact Mode is specifically designed for quickly understanding algorithms. Evaluation Mode is specifically designed for reproducing paper results and scientific research.
• Fair Comparison Platform: Provides benchmark results for 6 algorithms across 5 task types and 10 datasets.
• Efficient Retriever Client: Offers local API for parallel access and caching, with average latency under 1 second.
• Versatile Generator Support: Compatible with 70B+ models, VLLM, and quantization techniques.
• Flexible Instruction Lab: Customizable instruction templates for various RAG scenarios.

🔨Install environment

• dev environment：pytorch:2.0.1-py3.10-cuda11.8.0-devel-ubuntu22.04

• install miniconda

• git clone RAGLAB

  https://github.com/fate-ubw/RAGLAB.git

• create environment from yml file

  cd RAGLAB
  conda env create -f environment.yml

• install flash-attn, en_core_web_sm, punkt manually

  pip install flash-attn==2.2
  python -m spacy download en_core_web_sm
  python -m nltk.downloader punkt

🤗 Models

raglab need several models please download them

cd RAGLAB
mkdir model
cd model
mkdir output_models
# retriever model
mkdir colbertv2.0
huggingface-cli download colbert-ir/colbertv2.0 --local-dir colbertv2.0/ --local-dir-use-symlinks False
mkdir contriever-msmarco
huggingface-cli download facebook/contriever-msmarco --local-dir contriever-msmarco/ --local-dir-use-symlinks False

# finetuned generator
# 8B model
mkdir Llama3-8B-baseline
huggingface-cli download RAGLAB/Llama3-8B-baseline --local-dir Llama3-8B-baseline/ --local-dir-use-symlinks False
mkdir selfrag_llama3_8b-epoch_0_1
huggingface-cli download RAGLAB/selfrag_llama3-8B --local-dir selfrag_llama3_8b-epoch_0_1/ --local-dir-use-symlinks False
# 70B model
mkdir Llama3-70B-baseline-adapter
huggingface-cli download RAGLAB/Llama3-70B-baseline-adapter --local-dir Llama3-70B-baseline-adapter/ --local-dir-use-symlinks False
mkdir selfrag_llama3_70B-adapter
huggingface-cli download RAGLAB/selfrag_llama3-70B-adapter --local-dir selfrag_llama3_70B-adapter/ --local-dir-use-symlinks False
mkdir Meta-Llama-3-70B
huggingface-cli download meta-llama/Meta-Llama-3-70B --local-dir Meta-Llama-3-70B/ --local-dir-use-symlinks False

# base model for finetune and LoRA
mkdir Meta-Llama-3-8B
huggingface-cli download meta-llama/Meta-Llama-3-8B --local-dir Meta-Llama-3-8B/ --local-dir-use-symlinks False


# ALCE Metric Models
mkdir gpt2-large
huggingface-cli download openai-community/gpt2-large --local-dir gpt2-large/ --local-dir-use-symlinks False
mkdir roberta-large-squad
huggingface-cli download gaotianyu1350/roberta-large-squad --local-dir roberta-large-squad/ --local-dir-use-symlinks False
mkdir t5_xxl_true_nli_mixture
huggingface-cli download google/t5_xxl_true_nli_mixture --local-dir t5_xxl_true_nli_mixture/ --local-dir-use-symlinks False

# factscore model we use gpt3.5 for evaluation, so no need to download local models

# models from official selfrag repo
mkdir selfrag_llama2_7b
huggingface-cli download selfrag/selfrag_llama2_7b --local-dir selfrag_llama2_7b/ --local-dir-use-symlinks False
# you can download other model as generator from huggingface

🤗 Whole Data

• If you only need to understand how different algorithms work, the interact mode developed by RAGLAB can meet your needs.
• If you want to reproduce the results from the papers, you need to download all the required data from Hugging Face, including training data, knowledge data, and evaluation data. We have packaged all the data for you, so you just need to download it and it's ready to use.

  cd RAGLAB
  huggingface-cli download RAGLAB/data --local-dir data --repo-type dataset

Run Raglab in Interact Mode

• Interact Mode is specifically designed for quickly understanding algorithms. In interact mode, you can run various algorithms very quickly, understand the reasoning process of different algorithms, without needing to download any additional data.

Setup colbert server

• All algorithms integrated in raglab include two modes: interact and evaluation. The test stage demonstrates in interact mode, just for demostration and eduction 🤗.
• Due to colbert's requirement for absolute paths, you need to modify the index_dbPath and text_dbPath in the config file to use absolute paths.
• Modify the index_dbPath and text_dbPath in config file:colbert_server-10samples.yaml

  index_dbPath: /your_root_path/RAGLAB/data/retrieval/colbertv2.0_embedding/wiki2023-10samples
  text_dbPath: /your_root_path/RAGLAB/data/retrieval/colbertv2.0_passages/wiki2023-10samples/enwiki-20230401-10samples.tsv

• run colbert server

  cd RAGLAB
  sh run/colbert_server/colbert_server-10samples.sh

  • At this point, colbert embedding will prompt that due to path errors, colbert embedding needs to be reprocessed. Please enter yes and then raglab will automatically help you process the embedding and start the colbert server.
• Now please open another terminal and try to request the colbert server

  cd RAGLAB
  sh run/colbert_server/ask_api.sh

  • If a result is returned, it means the colbert server has started successfully! 🌈
• run selfrag (short form & adaptive retrieval) interact mode test 10-samples embedding

  cd RAGLAB
  sh run/rag_inference/3-selfrag_reproduction-interact-short_form-adaptive_retrieval.sh

• Congratulations！！！Now you have already know how to run raglab 🌈
• In raglab, each algorithm has 10 queries built-in in interact mode which are sampled from different benchmarks

Reproduce paper results

• remember download wiki2018 konwledge database and model before runing paper results

Retrieval server & api

• Due to colbert's requirement for absolute paths, you need to modify the index_dbPath and text_dbPath in config file and process the wiki2018 embedding database
  • Modify the paths in the config file

  cd RAGLAB/config/colbert_server
  vim colbert_server.yaml
  index_dbPath: {your_root_path}/RAGLAB/data/retrieval/colbertv2.0_embedding/wiki2018
  text_dbPath: {your_root_path}/RAGLAB/data/retrieval/colbertv2.0_passages/wiki2018/wiki2018.tsv

  • Modify the absolute paths bound in the wiki2018 embedding source file

  vim /data/retrieval/colbertv2.0_embedding/wiki2018/indexes/wiki2018/metadata.json
  # change root path, other parameters do not need to be modified
  "collection": "/{your_root_path}/RAGLAB/data/retrieval/colbertv2.0_passages/wiki2018/wiki2018.tsv",
  "experiment": "/{your_root_path}/RAGLAB/data/retrieval/colbertv2.0_embedding/wiki2018",

• Attention: colbert_server need atleast 60GB ram

  cd RAGLAB
  sh run/colbert_server/colbert_server.sh

• open another terminal test your ColBERT server

  cd RAGLAB
  sh run/colbert_server/ask_api.sh

• ColBERT server started successfully!!! 🌈

Automatic GPU Scheduler

• inference experiments require running hundreds of scripts in parallel, the automatic gpu scheduler needs to be used to automatically allocate GPUs for different bash scripts in Parallel.
• install simple_gpu_scheduler

  pip install simple_gpu_scheduler

• run hundreds of experiments in one line 😎

  cd RAGLAB
  simple_gpu_scheduler --gpus 0,1,2,3,4,5,6,7 < auto_gpu_scheduling_scripts/auto_run-llama3_8b-baseline-scripts.txt

• how to write your_script.txt?
  • here is an example

  # auto_inference_selfreg-7b.txt
  sh run/rag_inference/selfrag_reproduction/selfrag_reproduction-evaluation-short_form-PubHealth-adaptive_retrieval-pregiven_passages.sh
  sh run/rag_inference/selfrag_reproduction/selfrag_reproduction-evaluation-short_form-PubHealth-always_retrieval-pregiven_passages.sh

Process knowlwdge database

💽 process wiki2023 as vector database

10-samples test

• 10-samples test is aimed at validating the environment
• run colbert embedding process enwiki-20230401-10samples.tsv
  1. Change root path for variables: checkpoint, index_dbPath, collection in wiki2023-10samples_tsv-2-colbert_embedding.py. In file paths, colbert encounters many issues when using relative paths to generate embeddings. Therefore, the current version of raglab uses absolute paths.

    # change root path
  checkpoint = '/your_root_path/RAGLAB/model/colbertv2.0'
  index_dbPath = '/your_root_path/RAGLAB/data/retrieval/colbertv2.0_embedding/wiki2023-10samples'
  collection = '/your_root_path/RAGLAB/data/retrieval/colbertv2.0_passages/wiki2023-10samples/enwiki-20230401-10samples.tsv'

  2. run

  cd RAGLAB
  sh run/wiki2023_preprocess/2-wiki2023-10samples_tsv-2-colbert_embedding.sh

• Embedding precess will take around 15mins in first time.
• The first time colbert processes embeddings, it takes a relatively long time because it needs to recompile the torch_extensions. However, calling the processed embeddings does not require a long time. If there are no errors and the retrieved text can be printed, it indicates that the environment is correct.

embedding whole wiki2023

• you can download the colbert embdding wiki2023 as raglab database(40Gb)

cd /RAGLAB/data/retrieval/colbertv2.0_embedding
gdown --id xxxxxx

• modify the path in meta.json file
• embedding whole wiki2023 to vector need 22 hours, so we recommend download prepared embedding

download wiki2023 raw data

• current version of raglab use wiki2023 as database
• we get source wiki2023 get from factscore
  • method1: url for download wiki2023:google_drive
  • method2: install throuth gdown

  cd RAGLAB/data/retrieval/colbertv2.0_passages
  mkdir wiki2023
  pip install gdown
  gdown --id 1mekls6OGOKLmt7gYtHs0WGf5oTamTNat

preprocess wiki2023

• If the 10-samples test is passed successfully, you can proceed with processing wiki2023.

1. preprocess .db -> .tsv (Colbert can only read files in .tsv format.)

   cd RAGLAB
   sh run/wiki2023_preprocess/3-wiki2023_db-2-tsv.sh

2. .tsv -> embedding

• remember to change the root path of checkpoint, index_dbPath and collection

    # change root path
      checkpoint = '/your_root_path/RAGLAB/model/colbertv2.0'
      index_dbPath = '/your_root_path/RAGLAB/data/retrieval/colbertv2.0_embedding/wiki2023-10samples'
      collection = '/your_root_path/RAGLAB/data/retrieval/colbertv2.0_passages/wiki2023-10samples/enwiki-20230401-10samples.tsv'

• run bash script

  cd RAGLAB
  sh run/wiki2023_preprocess/4-wiki2023_tsv-2-colbert_embedding.sh

💽 Process wiki2018 as vector database

• This section is a tutorial on using wiki2018

Download text files

• Directly download wiki2018 raw database using wget

cd RAGLAB/data/retrieval/colbertv2.0_passages/wiki2018
wget https://dl.fbaipublicfiles.com/dpr/wikipedia_split/psgs_w100.tsv.gz

Process raw wiki2018 into colbert format

cd RAGLAB
sh run/wiki2018_preprocess/1-wiki2018_tsv_2_tsv.sh

Modify wiki2018 embedding config file

1. Change the path

cd /RAGLAB/data/retrieval/colbertv2.0_embedding/wiki2018/indexes/wiki2018
vim metadata.json 

• You only need to modify two paths in the metadata.json file. Here, simply delete the original paths and copy the following paths. Other parameters do not need to be modified.

"collection": "/home/ec2-user/SageMaker/RAGLAB/data/retrieval/colbertv2.0_passages/wiki2018/wiki2018.tsv",
"experiment": "/home/ec2-user/SageMaker/RAGLAB/data/retrieval/colbertv2.0_embedding/wiki2018",

• After modification, you can directly start the colbert server. For experimental startup method, refer to the last section of the readme: Inference experiments.

🤖 Train models

• This section covers the process of training models in RAGLAB. You can either download all pre-trained models from HuggingFace🤗, or use the tutorial below to train from scratch📝.
• All data provides all data necessary for finetuning.

10-samples test for fintune

• The 10-samples train dataset has been processed, please directly start the bash script to begin testing.
• Note: The test script only uses one GPU
  • full weight requires 80GB VRam GPU

  cd RAGLAB
  sh run/rag_train/script_finetune-llama3-baseline-full_weight-10samples.sh

  • LoRA (Low-Rank Adaptation) requires at least 26GB of VRAM

  cd RAGLAB
  sh run/rag_train/script_finetune-llama3-baseline-Lora-10samples.sh

• Congratulations！！！You can now start fine-tuning the baseline model and selfrag-8B

finetune self rag 8b

• full weight finetune

  cd RAGLAB
  sh run/rag_train/script_finetune-selfrag_8b-full_weight.sh

• lora finetune

  cd RAGLAB
  sh run/rag_train/script_finetune-selfrag_8b-Lora.sh

finetune llama3-8b as baseline

• preprocess train data. Train data for baseline model need remove special tokens.

  cd RAGLAB
  sh run/traindataset_preprocess/selfrag_traindata-remove_special_tokens.sh

• then you will get baseline train_data without special token and passages (Q: what is specal token? Anawer: special tokens is a concept proposed by SelfRAG)
• full weight finetune llama3-8b-baseline ues processed data

  sh run/rag_train/script_finetune-llama3-baseline-full_weight.sh

• lora finetune llama3-8b-baseline

  cd RAGLAB
  sh run/rag_train/script_finetune-llama3-baseline-Lora.sh

Lora finetune llama3-70b as baseline

• preprocess train data. Train data for baseline model need remove special tokens.

  cd RAGLAB
  sh run/traindataset_preprocess/selfrag_traindata-remove_special_tokens.sh

• lora finetune llama3-70b-baseline ues processed data

  sh run/rag_train/script_finetune-llama3-70B-baseline-Lora.sh

QLora finetune llama3-70B as baseline

• preprocess train data. Train data for baseline model need remove special tokens.

  cd RAGLAB
  sh run/traindataset_preprocess/selfrag_traindata-remove_special_tokens.sh

• 8bit QLora finetune llama3-70B

  sh run/rag_train/script_finetune-llama3-70B-baseline-QLora-8bit.sh

• 4bit QLora fintune llama3-70B

  sh run/rag_train/script_finetune-llama3-70B-baseline-QLora-4bit.sh

8bit QLora finetune selfrag-70B as baseline

• 8bit Qlora finetune slefrag 70B

    sh run/rag_train/script_finetune-selfrag_llama3-70b-QLora-8bit.sh

• 4bit Qlora finetune slefrag 70B

    sh run/rag_train/script_finetune-selfrag_llama3-70b-QLora-4bit.sh

🔖 License

FlashRAG is licensed under the MIT License.