base on AutoRAG: An Open-Source Framework for Retrieval-Augmented Generation (RAG) Evaluation & Optimization with AutoML-Style Automation # AutoRAG RAG AutoML tool for automatically finding an optimal RAG pipeline for your data.    [](https://www.linkedin.com/company/104375108/admin/dashboard/)  [](https://huggingface.co/AutoRAG) [](https://github.com/orgs/Auto-RAG/projects/1/views/2) <img src=https://github.com/user-attachments/assets/9a4d0381-a161-457f-a787-e7eb3593ce00 width="251.5" height="55.2"/> There are many RAG pipelines and modules out there, but you don’t know what pipeline is great for “your own data” and "your own use-case." Making and evaluating all RAG modules is very time-consuming and hard to do. But without it, you will never know which RAG pipeline is the best for your own use-case. AutoRAG is a tool for finding the optimal RAG pipeline for “your data.” You can evaluate various RAG modules automatically with your own evaluation data and find the best RAG pipeline for your own use-case. AutoRAG supports a simple way to evaluate many RAG module combinations. Try now and find the best RAG pipeline for your own use-case. Explore our 📖 [Document](https://docs.auto-rag.com)!! Plus, join our 📞 [Discord](https://discord.gg/P4DYXfmSAs) Community. --- Do you have any difficulties in optimizing your RAG pipeline? Or is it hard to set up things to use AutoRAG? Try [**AutoRAG Cloud**](https://tally.so/r/n0jOrZ) beta. We will help you to run AutoRAG and optimize. Plus, we can help you to build RAG evaluation dataset. Starts with 9.99$ per optimization. --- ## YouTube Tutorial https://github.com/Marker-Inc-Korea/AutoRAG/assets/96727832/c0d23896-40c0-479f-a17b-aa2ec3183a26 _Muted by default, enable sound for voice-over_ You can see on [YouTube](https://youtu.be/2ojK8xjyXAU?feature=shared) ## Use AutoRAG in HuggingFace Space 🚀 - [💬 Naive RAG Chatbot](https://huggingface.co/spaces/AutoRAG/Naive-RAG-chatbot) - [✏️ AutoRAG Data Creation](https://huggingface.co/spaces/AutoRAG/AutoRAG-data-creation) - [🚀 AutoRAG RAG Pipeline Optimization](https://huggingface.co/spaces/AutoRAG/AutoRAG-optimization) ## Colab Tutorial - [Step 1: Basic of AutoRAG | Optimizing your RAG pipeline](https://colab.research.google.com/drive/19OEQXO_pHN6gnn2WdfPd4hjnS-4GurVd?usp=sharing) - [Step 2: Data Creation | Create your own Data for RAG Optimization](https://colab.research.google.com/drive/1BOdzMndYgMY_iqhwKcCCS7ezHbZ4Oz5X?usp=sharing) - [Step 3: Use Custom LLM & Embedding Model | Use Custom Model](https://colab.research.google.com/drive/12VpWcSTSOsLSyW0BKb-kPoEzK22ACxvS?usp=sharing) # Index - [Quick Install](#quick-install) - [Data Creation](#data-creation) - [Parsing](#1-parsing) - [Chunking](#2-chunking) - [QA Creation](#3-qa-creation) - [RAG Optimization](#rag-optimization) - [How AutoRAG optimizes RAG pipeline?](#how-autorag-optimizes-rag-pipeline) - [Metrics](#metrics) - [Quick Start](#quick-start-1) - [Set YAML File](#1-set-yaml-file) - [Run AutoRAG](#2-run-autorag) - [Run Dashboard](#3-run-dashboard) - [Deploy your optimal RAG pipeline](#4-deploy-your-optimal-rag-pipeline) - [🐳 AutoRAG Docker Guide](#-autorag-docker-guide) - [FaQ](#-faq) # Quick Install We recommend using Python version 3.10 or higher for AutoRAG. ```bash pip install AutoRAG ``` If you want to use the local models, you need to install gpu version. ```bash pip install "AutoRAG[gpu]" ``` Or for parsing, you can use the parsing version. ```bash pip install "AutoRAG[gpu,parse]" ``` # Data Creation <a href="https://huggingface.co/spaces/AutoRAG/AutoRAG-data-creation"> <img src="https://github.com/user-attachments/assets/8c6e4b02-3938-4560-b817-c95764965b50" alt="Hugging Face Sticker" style="width:200px;height:auto;"> </a>   RAG Optimization requires two types of data: QA dataset and Corpus dataset. 1. **QA** dataset file (qa.parquet) 2. **Corpus** dataset file (corpus.parquet) **QA** dataset is important for accurate and reliable evaluation and optimization. **Corpus** dataset is critical to the performance of RAGs. This is because RAG uses the corpus to retrieve documents and generate answers using it. ### 📌 Supporting Data Creation Modules  - [Supporting Parsing Modules List](https://edai.notion.site/Supporting-Parsing-Modules-e0b7579c7c0e4fb2963e408eeccddd75?pvs=4) - [Supporting Chunking Modules List](https://edai.notion.site/Supporting-Chunk-Modules-8db803dba2ec4cd0a8789659106e86a3?pvs=4) ## Quick Start ### 1. Parsing #### Set YAML File ```yaml modules: - module_type: langchain_parse parse_method: pdfminer ``` You can also use multiple Parse modules at once. However, in this case, you'll need to return a new process for each parsed result. #### Start Parsing You can parse your raw documents with just a few lines of code. ```python from autorag.parser import Parser parser = Parser(data_path_glob="your/data/path/*") parser.start_parsing("your/path/to/parse_config.yaml") ``` ### 2. Chunking #### Set YAML File ```yaml modules: - module_type: llama_index_chunk chunk_method: Token chunk_size: 1024 chunk_overlap: 24 add_file_name: en ``` You can also use multiple Chunk modules at once. In this case, you need to use one corpus to create QA and then map the rest of the corpus to QA Data. If the chunk method is different, the retrieval_gt will be different, so we need to remap it to the QA dataset. #### Start Chunking You can chunk your parsed results with just a few lines of code. ```python from autorag.chunker import Chunker chunker = Chunker.from_parquet(parsed_data_path="your/parsed/data/path") chunker.start_chunking("your/path/to/chunk_config.yaml") ``` ### 3. QA Creation You can create QA dataset with just a few lines of code. ```python import pandas as pd from llama_index.llms.openai import OpenAI from autorag.data.qa.filter.dontknow import dontknow_filter_rule_based from autorag.data.qa.generation_gt.llama_index_gen_gt import ( make_basic_gen_gt, make_concise_gen_gt, ) from autorag.data.qa.schema import Raw, Corpus from autorag.data.qa.query.llama_gen_query import factoid_query_gen from autorag.data.qa.sample import random_single_hop llm = OpenAI() raw_df = pd.read_parquet("your/path/to/parsed.parquet") raw_instance = Raw(raw_df) corpus_df = pd.read_parquet("your/path/to/corpus.parquet") corpus_instance = Corpus(corpus_df, raw_instance) initial_qa = ( corpus_instance.sample(random_single_hop, n=3) .map( lambda df: df.reset_index(drop=True), ) .make_retrieval_gt_contents() .batch_apply( factoid_query_gen, # query generation llm=llm, ) .batch_apply( make_basic_gen_gt, # answer generation (basic) llm=llm, ) .batch_apply( make_concise_gen_gt, # answer generation (concise) llm=llm, ) .filter( dontknow_filter_rule_based, # filter don't know lang="en", ) ) initial_qa.to_parquet('./qa.parquet', './corpus.parquet') ``` # RAG Optimization <a href="https://huggingface.co/spaces/AutoRAG/RAG-Pipeline-Optimization"> <img src="https://github.com/user-attachments/assets/8c6e4b02-3938-4560-b817-c95764965b50" alt="Hugging Face Sticker" style="width:200px;height:auto;"> </a>   ## How AutoRAG optimizes RAG pipeline? Here is the AutoRAG RAG Structure that only show Nodes.  Here is the image showing all the nodes and modules.   ### 📌 Supporting RAG Optimization Nodes & modules - [Supporting RAG Modules list](https://edai.notion.site/Supporting-Nodes-modules-0ebc7810649f4e41aead472a92976be4?pvs=4) ## Metrics The metrics used by each node in AutoRAG are shown below.   - [Supporting metrics list](https://edai.notion.site/Supporting-metrics-867d71caefd7401c9264dd91ba406043?pvs=4) Here is the detailed information about the metrics that AutoRAG supports. - [Retrieval Metrics](https://edai.notion.site/Retrieval-Metrics-dde3d9fa1d9547cdb8b31b94060d21e7?pvs=4) - [Retrieval Token Metrics](https://edai.notion.site/Retrieval-Token-Metrics-c3e2d83358e04510a34b80429ebb543f?pvs=4) - [Generation Metrics](https://github.com/user-attachments/assets/7d4a3069-9186-4854-885d-ca0f7bcc17e8) ## Quick Start ### 1. Set YAML File First, you need to set the config YAML file for your RAG optimization. We highly recommend using pre-made config YAML files for starter. - [Get Sample YAML](./sample_config/rag) - [Sample YAML Guide](https://docs.auto-rag.com/optimization/sample_config.html) - [Make Custom YAML Guide](https://docs.auto-rag.com/optimization/custom_config.html) Here is an example of the config YAML file to use `retrieval`, `prompt_maker`, and `generator` nodes. ```yaml node_lines: - node_line_name: retrieve_node_line # Set Node Line (Arbitrary Name) nodes: - node_type: retrieval # Set Retrieval Node strategy: metrics: [retrieval_f1, retrieval_recall, retrieval_ndcg, retrieval_mrr] # Set Retrieval Metrics top_k: 3 modules: - module_type: vectordb vectordb: default - module_type: bm25 - module_type: hybrid_rrf weight_range: (4,80) - node_line_name: post_retrieve_node_line # Set Node Line (Arbitrary Name) nodes: - node_type: prompt_maker # Set Prompt Maker Node strategy: metrics: # Set Generation Metrics - metric_name: meteor - metric_name: rouge - metric_name: sem_score embedding_model: openai modules: - module_type: fstring prompt: "Read the passages and answer the given question. \n Question: {query} \n Passage: {retrieved_contents} \n Answer : " - node_type: generator # Set Generator Node strategy: metrics: # Set Generation Metrics - metric_name: meteor - metric_name: rouge - metric_name: sem_score embedding_model: openai modules: - module_type: openai_llm llm: gpt-4o-mini batch: 16 ``` ### 2. Run AutoRAG You can evaluate your RAG pipeline with just a few lines of code. ```python from autorag.evaluator import Evaluator evaluator = Evaluator(qa_data_path='your/path/to/qa.parquet', corpus_data_path='your/path/to/corpus.parquet') evaluator.start_trial('your/path/to/config.yaml') ``` or you can use the command line interface ```bash autorag evaluate --config your/path/to/default_config.yaml --qa_data_path your/path/to/qa.parquet --corpus_data_path your/path/to/corpus.parquet ``` Once it is done, you can see several files and folders created in your current directory. At the trial folder named to numbers (like 0), you can check `summary.csv` file that summarizes the evaluation results and the best RAG pipeline for your data. For more details, you can check out how the folder structure looks like at [here](https://docs.auto-rag.com/optimization/folder_structure.html). ### 3. Run Dashboard You can run a dashboard to easily see the result. ```bash autorag dashboard --trial_dir /your/path/to/trial_dir ``` #### sample dashboard  ### 4. Deploy your optimal RAG pipeline ### 4-1. Run as a Code You can use an optimal RAG pipeline right away from the trial folder. The trial folder is the directory used in the running dashboard. (like 0, 1, 2, ...) ```python from autorag.deploy import Runner runner = Runner.from_trial_folder('/your/path/to/trial_dir') runner.run('your question') ``` ### 4-2. Run as an API server You can run this pipeline as an API server. Check out the API endpoint at [here](./docs/source/deploy/api_endpoint.md). ```python import nest_asyncio from autorag.deploy import ApiRunner nest_asyncio.apply() runner = ApiRunner.from_trial_folder('/your/path/to/trial_dir') runner.run_api_server() ``` ```bash autorag run_api --trial_dir your/path/to/trial_dir --host 0.0.0.0 --port 8000 ``` The cli command uses extracted config YAML file. If you want to know it more, check out [here](https://docs.auto-rag.com/tutorial.html#extract-pipeline-and-evaluate-test-dataset). ### 4-3. Run as a Web Interface you can run this pipeline as a web interface. Check out the web interface at [here](deploy/web.md). ```bash autorag run_web --trial_path your/path/to/trial_path ``` #### sample web interface <img width="1491" alt="web_interface" src="https://github.com/Marker-Inc-Korea/AutoRAG/assets/96727832/f6b00353-f6bb-4d8f-8740-1c264c0acbb8"> ### Use advanced web interface You can deploy the advanced web interface featured by [Kotaemon](https://github.com/Cinnamon/kotaemon) to the fly.io. Go [here](https://github.com/vkehfdl1/AutoRAG-web-kotaemon) to use it and deploy to the fly.io. Example :  ## 🐳 AutoRAG Docker Guide This guide provides a quick overview of building and running the AutoRAG Docker container for production, with instructions on setting up the environment for evaluation using your configuration and data paths. ### 🚀 Building the Docker Image Tip: If you want to build an image for a gpu version, you can use `autoraghq/autorag:gpu` or `autoraghq/autorag:gpu-parsing` #### 1.Download dataset for [Tutorial Step 1](https://colab.research.google.com/drive/19OEQXO_pHN6gnn2WdfPd4hjnS-4GurVd?usp=sharing) ```bash python sample_dataset/eli5/load_eli5_dataset.py --save_path projects/tutorial_1 ``` #### 2. Run `evaluate` > **Note**: This step may take a long time to complete and involves OpenAI API calls, which may cost approximately $0.30. ```bash docker run --rm -it \ -v ~/.cache/huggingface:/root/.cache/huggingface \ -v $(pwd)/projects:/usr/src/app/projects \ -e OPENAI_API_KEY=${OPENAI_API_KEY} \ autoraghq/autorag:api-latest evaluate \ --config /usr/src/app/projects/tutorial_1/config.yaml \ --qa_data_path /usr/src/app/projects/tutorial_1/qa_test.parquet \ --corpus_data_path /usr/src/app/projects/tutorial_1/corpus.parquet \ --project_dir /usr/src/app/projects/tutorial_1/ ``` #### 3. Run validate ```bash docker run --rm -it \ -v ~/.cache/huggingface:/root/.cache/huggingface \ -v $(pwd)/projects:/usr/src/app/projects \ -e OPENAI_API_KEY=${OPENAI_API_KEY} \ autoraghq/autorag:api-latest validate \ --config /usr/src/app/projects/tutorial_1/config.yaml \ --qa_data_path /usr/src/app/projects/tutorial_1/qa_test.parquet \ --corpus_data_path /usr/src/app/projects/tutorial_1/corpus.parquet ``` #### 4. Run `dashboard` ```bash docker run --rm -it \ -v ~/.cache/huggingface:/root/.cache/huggingface \ -v $(pwd)/projects:/usr/src/app/projects \ -e OPENAI_API_KEY=${OPENAI_API_KEY} \ -p 8502:8502 \ autoraghq/autorag:api-latest dashboard \ --trial_dir /usr/src/app/projects/tutorial_1/0 ``` #### 4. Run `run_web` ```bash docker run --rm -it \ -v ~/.cache/huggingface:/root/.cache/huggingface \ -v $(pwd)/projects:/usr/src/app/projects \ -e OPENAI_API_KEY=${OPENAI_API_KEY} \ -p 8501:8501 \ autoraghq/autorag:api-latest run_web --trial_path ./projects/tutorial_1/0 ``` #### Key Points : - **`-v ~/.cache/huggingface:/cache/huggingface`**: Mounts the host machine’s Hugging Face cache to `/cache/huggingface` in the container, enabling access to pre-downloaded models. - **`-e OPENAI_API_KEY: ${OPENAI_API_KEY}`**: Passes the `OPENAI_API_KEY` from your host environment. For more detailed instructions, refer to the [Docker Installation Guide](./docs/source/install.md#1-build-the-docker-image). ## ☎️ FaQ 🛣️ [Roadmap](https://github.com/orgs/Auto-RAG/projects/1/views/2) 💻 [Hardware Specs](https://edai.notion.site/Hardware-specs-28cefcf2a26246ffadc91e2f3dc3d61c?pvs=4) ⭐ [Running AutoRAG](https://edai.notion.site/About-running-AutoRAG-44a8058307af42068fc218a073ee480b?pvs=4) 🍯 [Tips/Tricks](https://edai.notion.site/Tips-Tricks-10708a0e36ff461cb8a5d4fb3279ff15?pvs=4) ☎️ [TroubleShooting](https://medium.com/@autorag/autorag-troubleshooting-5cf872b100e3) ## Thanks for shoutout ### Company <a href="https://www.linkedin.com/posts/llamaindex_rag-pipelines-have-a-lot-of-hyperparameters-activity-7182053546593247232-HFMN/"> <img src="https://github.com/user-attachments/assets/b8fdaaf6-543a-4019-8dbe-44191a5269b9" alt="llama index" style="width:200px;height:auto;"> </a> ### Individual - [Shubham Saboo](https://www.linkedin.com/posts/shubhamsaboo_just-found-the-solution-to-the-biggest-rag-activity-7255404464054939648-ISQ8/) - [Kalyan KS](https://www.linkedin.com/posts/kalyanksnlp_rag-autorag-llms-activity-7258677155574788097-NgS0/) ## 💬 Talk with Founders Talk with us! We are always open to talk with you. - 🎤 [Talk with Jeffrey](https://zcal.co/autorag-jeffrey/autorag-demo-15min) - 🦜 [Talk with Bwook](https://zcal.co/i/tcuLtmq5) --- # ✨ Contributors ✨ Thanks go to these wonderful people: <a href="https://github.com/Marker-Inc-Korea/AutoRAG/graphs/contributors"> <img src="https://contrib.rocks/image?repo=Marker-Inc-Korea/AutoRAG" /> </a> # Contribution We are developing AutoRAG as open-source. So this project welcomes contributions and suggestions. Feel free to contribute to this project. Plus, check out our detailed documentation at [here](https://docs.auto-rag.com/index.html). ## Citation ```bibtex @misc{kim2024autoragautomatedframeworkoptimization, title={AutoRAG: Automated Framework for optimization of Retrieval Augmented Generation Pipeline}, author={Dongkyu Kim and Byoungwook Kim and Donggeon Han and Matouš Eibich}, year={2024}, eprint={2410.20878}, archivePrefix={arXiv}, primaryClass={cs.CL}, url={https://arxiv.org/abs/2410.20878}, } ``` ", Assign "at most 3 tags" to the expected json: {"id":"7832","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"