{"id":13465307,"url":"https://github.com/Marker-Inc-Korea/AutoRAG","last_synced_at":"2025-03-25T16:31:38.710Z","repository":{"id":216493197,"uuid":"741450201","full_name":"Marker-Inc-Korea/AutoRAG","owner":"Marker-Inc-Korea","description":"AutoML tool for RAG","archived":false,"fork":false,"pushed_at":"2024-10-28T14:11:10.000Z","size":142294,"stargazers_count":2095,"open_issues_count":102,"forks_count":164,"subscribers_count":20,"default_branch":"main","last_synced_at":"2024-10-29T15:39:57.447Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://auto-rag.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Marker-Inc-Korea.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"autorag","polar":"Marker-Inc-Korea"}},"created_at":"2024-01-10T12:25:00.000Z","updated_at":"2024-10-29T15:38:51.000Z","dependencies_parsed_at":"2024-04-04T09:31:15.114Z","dependency_job_id":"f2f6efc6-5a2d-42e9-a837-d352420eb6cb","html_url":"https://github.com/Marker-Inc-Korea/AutoRAG","commit_stats":null,"previous_names":["marker-inc-korea/raground","marker-inc-korea/autorag"],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Marker-Inc-Korea%2FAutoRAG","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Marker-Inc-Korea%2FAutoRAG/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Marker-Inc-Korea%2FAutoRAG/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Marker-Inc-Korea%2FAutoRAG/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Marker-Inc-Korea","download_url":"https://codeload.github.com/Marker-Inc-Korea/AutoRAG/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222088539,"owners_count":16928976,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T15:00:26.642Z","updated_at":"2025-03-25T16:31:38.697Z","avatar_url":"https://github.com/Marker-Inc-Korea.png","language":"Python","funding_links":["https://ko-fi.com/autorag","https://polar.sh/Marker-Inc-Korea"],"categories":["Tools","LLM Frameworks","**Section 1: RAG, LlamaIndex, and Vector Storage**","*Ops for AI","Python","A01_文本生成_文本对话","LLM Application / RAG","知识库 RAG","Repos","AutoML","Industry Strength Information Retrieval","LLM Applications","Libraries/Frameworks","9. Evaluation, Benchmarks \u0026 Datasets"],"sub_categories":["AutoRAG","**RAG Solution Design \u0026 Application**","LLMOps","大语言对话模型及数据","Profiling"],"readme":"# AutoRAG\n\nRAG AutoML tool for automatically finding an optimal RAG pipeline for your data.\n\n![Thumbnail](https://github.com/user-attachments/assets/6bab243d-a4b3-431a-8ac0-fe17336ab4de)\n\n![Discord](https://img.shields.io/discord/1204010535272587264) ![PyPI - Downloads](https://img.shields.io/pypi/dm/AutoRAG)\n[![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?style=flat-square\u0026logo=linkedin)](https://www.linkedin.com/company/104375108/admin/dashboard/)\n![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/AutoRAG_HQ)\n[![Hugging Face](https://img.shields.io/badge/Hugging%20Face-Follow-orange?style=flat-square\u0026logo=huggingface)](https://huggingface.co/AutoRAG)\n[![Static Badge](https://img.shields.io/badge/Roadmap-5D3FD3)](https://github.com/orgs/Auto-RAG/projects/1/views/2)\n\n\u003cimg src=https://github.com/user-attachments/assets/9a4d0381-a161-457f-a787-e7eb3593ce00 width=\"251.5\" height=\"55.2\"/\u003e\n\nThere are many RAG pipelines and modules out there,\nbut you don’t know what pipeline is great for “your own data” and \"your own use-case.\"\nMaking and evaluating all RAG modules is very time-consuming and hard to do.\nBut without it, you will never know which RAG pipeline is the best for your own use-case.\n\nAutoRAG is a tool for finding the optimal RAG pipeline for “your data.”\nYou can evaluate various RAG modules automatically with your own evaluation data\nand find the best RAG pipeline for your own use-case.\n\nAutoRAG supports a simple way to evaluate many RAG module combinations.\nTry now and find the best RAG pipeline for your own use-case.\n\nExplore our 📖 [Document](https://docs.auto-rag.com)!!\n\nPlus, join our 📞 [Discord](https://discord.gg/P4DYXfmSAs) Community.\n\n---\n\n## AutoRAG GUI (beta)\n\nAutoRAG GUI is a web-based GUI for AutoRAG.\nIf AutoRAG is a little bit complicated to you, try AutoRAG GUI.\n\nYour Optimized RAG pipeline is just a few clicks away.\n\n|                                    Project Management                                     |                                    Easy Configuration                                     |                                     Parsed Page View                                      |\n|:-----------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------:|\n| ![Image](https://github.com/user-attachments/assets/87289d84-ff65-4810-bc41-3f30b36b7ddf) | ![Image](https://github.com/user-attachments/assets/dbe0a49b-ebf2-4c9c-b17d-1be1c2cd1060) | ![Image](https://github.com/user-attachments/assets/d8a50512-3299-4b68-b48e-e2f49d688f01) |\n\nClick the docs to use the AutoRAG GUI beta version! [AutoRAG GUI Docs](https://docs.auto-rag.com/gui/gui.html).\n\n### GUI Installation\n\n1. Clone the repository\n2. Run Docker Compose `docker compose up -d`\n3. Access the GUI at `http://localhost:3000`\n\n---\n\n## YouTube Tutorial\n\nhttps://github.com/Marker-Inc-Korea/AutoRAG/assets/96727832/c0d23896-40c0-479f-a17b-aa2ec3183a26\n\n_Muted by default, enable sound for voice-over_\n\nYou can see on [YouTube](https://youtu.be/2ojK8xjyXAU?feature=shared)\n\n## Use AutoRAG in HuggingFace Space 🚀\n\n- [💬 Naive RAG Chatbot](https://huggingface.co/spaces/AutoRAG/Naive-RAG-chatbot)\n- [✏️ AutoRAG Data Creation](https://huggingface.co/spaces/AutoRAG/AutoRAG-data-creation)\n- [🚀 AutoRAG RAG Pipeline Optimization](https://huggingface.co/spaces/AutoRAG/AutoRAG-optimization)\n\n## Colab Tutorial\n\n- [Step 1: Basic of AutoRAG | Optimizing your RAG pipeline](https://colab.research.google.com/drive/19OEQXO_pHN6gnn2WdfPd4hjnS-4GurVd?usp=sharing)\n- [Step 2: Data Creation | Create your own Data for RAG Optimization](https://colab.research.google.com/drive/1BOdzMndYgMY_iqhwKcCCS7ezHbZ4Oz5X?usp=sharing)\n- [Step 3: Use Custom LLM \u0026 Embedding Model | Use Custom Model](https://colab.research.google.com/drive/12VpWcSTSOsLSyW0BKb-kPoEzK22ACxvS?usp=sharing)\n\n# Index\n\n- [Quick Install](#quick-install)\n- [Data Creation](#data-creation)\n    - [Parsing](#1-parsing)\n    - [Chunking](#2-chunking)\n    - [QA Creation](#3-qa-creation)\n- [RAG Optimization](#rag-optimization)\n    - [How AutoRAG optimizes RAG pipeline?](#how-autorag-optimizes-rag-pipeline)\n    - [Metrics](#metrics)\n    - [Quick Start](#quick-start-1)\n        - [Set YAML File](#1-set-yaml-file)\n        - [Run AutoRAG](#2-run-autorag)\n        - [Run Dashboard](#3-run-dashboard)\n        - [Deploy your optimal RAG pipeline](#4-deploy-your-optimal-rag-pipeline)\n- [🐳 AutoRAG Docker Guide](#-autorag-docker-guide)\n- [FaQ](#-faq)\n\n# Quick Install\n\nWe recommend using Python version 3.10 or higher for AutoRAG.\n\n```bash\npip install AutoRAG\n```\n\nIf you want to use the local models, you need to install gpu version.\n\n```bash\npip install \"AutoRAG[gpu]\"\n```\n\nOr for parsing, you can use the parsing version.\n\n```bash\npip install \"AutoRAG[gpu,parse]\"\n```\n\n# Data Creation\n\n\u003ca href=\"https://huggingface.co/spaces/AutoRAG/AutoRAG-data-creation\"\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/8c6e4b02-3938-4560-b817-c95764965b50\" alt=\"Hugging Face Sticker\" style=\"width:200px;height:auto;\"\u003e\n\u003c/a\u003e\n\n![Image](https://github.com/user-attachments/assets/146d005d-dcb9-4460-a8b3-25126e5e3dc2)\n\n![image](https://github.com/user-attachments/assets/6079f696-207c-4221-8d28-5561a203dfe2)\n\nRAG Optimization requires two types of data: QA dataset and Corpus dataset.\n\n1. **QA** dataset file (qa.parquet)\n2. **Corpus** dataset file (corpus.parquet)\n\n**QA** dataset is important for accurate and reliable evaluation and optimization.\n\n**Corpus** dataset is critical to the performance of RAGs.\nThis is because RAG uses the corpus to retrieve documents and generate answers using it.\n\n### 📌 Supporting Data Creation Modules\n\n![Image](https://github.com/user-attachments/assets/c6f15fab-6c69-4627-9685-6c218b66f5d6)\n\n- [Supporting Parsing Modules List](https://edai.notion.site/Supporting-Parsing-Modules-e0b7579c7c0e4fb2963e408eeccddd75?pvs=4)\n- [Supporting Chunking Modules List](https://edai.notion.site/Supporting-Chunk-Modules-8db803dba2ec4cd0a8789659106e86a3?pvs=4)\n\n## Quick Start\n\n### 1. Parsing\n\n#### Set YAML File\n\n```yaml\nmodules:\n  - module_type: langchain_parse\n    parse_method: pdfminer\n```\n\nYou can also use multiple Parse modules at once.\nHowever, in this case, you'll need to return a new process for each parsed result.\n\n#### Start Parsing\n\nYou can parse your raw documents with just a few lines of code.\n\n```python\nfrom autorag.parser import Parser\n\nparser = Parser(data_path_glob=\"your/data/path/*\")\nparser.start_parsing(\"your/path/to/parse_config.yaml\")\n```\n\n### 2. Chunking\n\n#### Set YAML File\n\n```yaml\nmodules:\n  - module_type: llama_index_chunk\n    chunk_method: Token\n    chunk_size: 1024\n    chunk_overlap: 24\n    add_file_name: en\n```\n\nYou can also use multiple Chunk modules at once.\nIn this case, you need to use one corpus to create QA and then map the rest of the corpus to QA Data.\nIf the chunk method is different, the retrieval_gt will be different, so we need to remap it to the QA dataset.\n\n#### Start Chunking\n\nYou can chunk your parsed results with just a few lines of code.\n\n```python\nfrom autorag.chunker import Chunker\n\nchunker = Chunker.from_parquet(parsed_data_path=\"your/parsed/data/path\")\nchunker.start_chunking(\"your/path/to/chunk_config.yaml\")\n```\n\n### 3. QA Creation\n\nYou can create QA dataset with just a few lines of code.\n\n```python\nimport pandas as pd\nfrom llama_index.llms.openai import OpenAI\n\nfrom autorag.data.qa.filter.dontknow import dontknow_filter_rule_based\nfrom autorag.data.qa.generation_gt.llama_index_gen_gt import (\n\tmake_basic_gen_gt,\n\tmake_concise_gen_gt,\n)\nfrom autorag.data.qa.schema import Raw, Corpus\nfrom autorag.data.qa.query.llama_gen_query import factoid_query_gen\nfrom autorag.data.qa.sample import random_single_hop\n\nllm = OpenAI()\nraw_df = pd.read_parquet(\"your/path/to/parsed.parquet\")\nraw_instance = Raw(raw_df)\n\ncorpus_df = pd.read_parquet(\"your/path/to/corpus.parquet\")\ncorpus_instance = Corpus(corpus_df, raw_instance)\n\ninitial_qa = (\n\tcorpus_instance.sample(random_single_hop, n=3)\n\t.map(\n\t\tlambda df: df.reset_index(drop=True),\n\t)\n\t.make_retrieval_gt_contents()\n\t.batch_apply(\n\t\tfactoid_query_gen,  # query generation\n\t\tllm=llm,\n\t)\n\t.batch_apply(\n\t\tmake_basic_gen_gt,  # answer generation (basic)\n\t\tllm=llm,\n\t)\n\t.batch_apply(\n\t\tmake_concise_gen_gt,  # answer generation (concise)\n\t\tllm=llm,\n\t)\n\t.filter(\n\t\tdontknow_filter_rule_based,  # filter don't know\n\t\tlang=\"en\",\n\t)\n)\n\ninitial_qa.to_parquet('./qa.parquet', './corpus.parquet')\n```\n\n# RAG Optimization\n\n\u003ca href=\"https://huggingface.co/spaces/AutoRAG/RAG-Pipeline-Optimization\"\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/8c6e4b02-3938-4560-b817-c95764965b50\" alt=\"Hugging Face Sticker\" style=\"width:200px;height:auto;\"\u003e\n\u003c/a\u003e\n\n![Image](https://github.com/user-attachments/assets/b814928d-54a4-4b96-af34-adba0ac6803b)\n\n![rag](https://github.com/user-attachments/assets/214d842e-fc67-4113-9c24-c94158b00c23)\n\n## How AutoRAG optimizes RAG pipeline?\n\nHere is the AutoRAG RAG Structure that only show Nodes.\n\n![Image](https://github.com/user-attachments/assets/cbc60938-e211-4fbf-be74-31bd9a997581)\n\nHere is the image showing all the nodes and modules.\n\n![Image](https://github.com/user-attachments/assets/9489e803-f47a-49d4-97ec-0dd9b270394f)\n\n![rag_opt_gif](https://github.com/user-attachments/assets/55bd09cd-8420-4f6d-bc7d-0a66af288317)\n\n### 📌 Supporting RAG Optimization Nodes \u0026 modules\n\n- [Supporting RAG Modules list](https://edai.notion.site/Supporting-Nodes-modules-0ebc7810649f4e41aead472a92976be4?pvs=4)\n\n## Metrics\n\nThe metrics used by each node in AutoRAG are shown below.\n\n![Image](https://github.com/user-attachments/assets/5b342f68-d25c-4cba-aa85-1e257801afea)\n\n![Image](https://github.com/user-attachments/assets/393d3ad6-1bde-4e75-b314-5c150eadaeee)\n\n- [Supporting metrics list](https://edai.notion.site/Supporting-metrics-867d71caefd7401c9264dd91ba406043?pvs=4)\n\nHere is the detailed information about the metrics that AutoRAG supports.\n\n- [Retrieval Metrics](https://edai.notion.site/Retrieval-Metrics-dde3d9fa1d9547cdb8b31b94060d21e7?pvs=4)\n- [Retrieval Token Metrics](https://edai.notion.site/Retrieval-Token-Metrics-c3e2d83358e04510a34b80429ebb543f?pvs=4)\n- [Generation Metrics](https://github.com/user-attachments/assets/7d4a3069-9186-4854-885d-ca0f7bcc17e8)\n\n## Quick Start\n\n### 1. Set YAML File\n\nFirst, you need to set the config YAML file for your RAG optimization.\n\nWe highly recommend using pre-made config YAML files for starter.\n\n- [Get Sample YAML](autorag/sample_config/rag)\n    - [Sample YAML Guide](https://docs.auto-rag.com/optimization/sample_config.html)\n- [Make Custom YAML Guide](https://docs.auto-rag.com/optimization/custom_config.html)\n\nHere is an example of the config YAML file to use `retrieval`, `prompt_maker`, and `generator` nodes.\n\n```yaml\nnode_lines:\n  - node_line_name: retrieve_node_line  # Set Node Line (Arbitrary Name)\n    nodes:\n      - node_type: retrieval  # Set Retrieval Node\n        strategy:\n          metrics: [ retrieval_f1, retrieval_recall, retrieval_ndcg, retrieval_mrr ]  # Set Retrieval Metrics\n        top_k: 3\n        modules:\n          - module_type: vectordb\n            vectordb: default\n          - module_type: bm25\n          - module_type: hybrid_rrf\n            weight_range: (4,80)\n  - node_line_name: post_retrieve_node_line  # Set Node Line (Arbitrary Name)\n    nodes:\n      - node_type: prompt_maker  # Set Prompt Maker Node\n        strategy:\n          metrics: # Set Generation Metrics\n            - metric_name: meteor\n            - metric_name: rouge\n            - metric_name: sem_score\n              embedding_model: openai\n        modules:\n          - module_type: fstring\n            prompt: \"Read the passages and answer the given question. \\n Question: {query} \\n Passage: {retrieved_contents} \\n Answer : \"\n      - node_type: generator  # Set Generator Node\n        strategy:\n          metrics: # Set Generation Metrics\n            - metric_name: meteor\n            - metric_name: rouge\n            - metric_name: sem_score\n              embedding_model: openai\n        modules:\n          - module_type: openai_llm\n            llm: gpt-4o-mini\n            batch: 16\n```\n\n### 2. Run AutoRAG\n\nYou can evaluate your RAG pipeline with just a few lines of code.\n\n```python\nfrom autorag.evaluator import Evaluator\n\nevaluator = Evaluator(qa_data_path='your/path/to/qa.parquet', corpus_data_path='your/path/to/corpus.parquet')\nevaluator.start_trial('your/path/to/config.yaml')\n```\n\nor you can use the command line interface\n\n```bash\nautorag evaluate --config your/path/to/default_config.yaml --qa_data_path your/path/to/qa.parquet --corpus_data_path your/path/to/corpus.parquet\n```\n\nOnce it is done, you can see several files and folders created in your current directory.\nAt the trial folder named to numbers (like 0),\nyou can check `summary.csv` file that summarizes the evaluation results and the best RAG pipeline for your data.\n\nFor more details, you can check out how the folder structure looks like\nat [here](https://docs.auto-rag.com/optimization/folder_structure.html).\n\n### 3. Run Dashboard\n\nYou can run a dashboard to easily see the result.\n\n```bash\nautorag dashboard --trial_dir /your/path/to/trial_dir\n```\n\n#### sample dashboard\n\n![dashboard](https://github.com/Marker-Inc-Korea/AutoRAG/assets/96727832/3798827d-31d7-4c4e-a9b1-54340b964e53)\n\n### 4. Deploy your optimal RAG pipeline\n\n### 4-1. Run as a Code\n\nYou can use an optimal RAG pipeline right away from the trial folder.\nThe trial folder is the directory used in the running dashboard. (like 0, 1, 2, ...)\n\n```python\nfrom autorag.deploy import Runner\n\nrunner = Runner.from_trial_folder('/your/path/to/trial_dir')\nrunner.run('your question')\n```\n\n### 4-2. Run as an API server\n\nYou can run this pipeline as an API server.\n\nCheck out the API endpoint at [here](./docs/source/deploy/api_endpoint.md).\n\n```python\nimport nest_asyncio\nfrom autorag.deploy import ApiRunner\n\nnest_asyncio.apply()\n\nrunner = ApiRunner.from_trial_folder('/your/path/to/trial_dir')\nrunner.run_api_server()\n```\n\n```bash\nautorag run_api --trial_dir your/path/to/trial_dir --host 0.0.0.0 --port 8000\n```\n\nThe cli command uses extracted config YAML file. If you want to know it more, check\nout [here](https://docs.auto-rag.com/tutorial.html#extract-pipeline-and-evaluate-test-dataset).\n\n### 4-3. Run as a Web Interface\n\nyou can run this pipeline as a web interface.\n\nCheck out the web interface at [here](deploy/web.md).\n\n```bash\nautorag run_web --trial_path your/path/to/trial_path\n```\n\n#### sample web interface\n\n\u003cimg width=\"1491\" alt=\"web_interface\" src=\"https://github.com/Marker-Inc-Korea/AutoRAG/assets/96727832/f6b00353-f6bb-4d8f-8740-1c264c0acbb8\"\u003e\n\n### Use advanced web interface\n\nYou can deploy the advanced web interface featured by [Kotaemon](https://github.com/Cinnamon/kotaemon) to the fly.io.\nGo [here](https://github.com/vkehfdl1/AutoRAG-web-kotaemon) to use it and deploy to the fly.io.\n\nExample :\n\n![Kotaemon Example](https://velog.velcdn.com/images/autorag/post/5e71b8d9-3e59-4e63-9191-355a1a5aa3a0/image.png)\n\n## 🐳 AutoRAG Docker Guide\n\nThis guide provides a quick overview of building and running the AutoRAG Docker container for production, with\ninstructions on setting up the environment for evaluation using your configuration and data paths.\n\n### 🚀 Building the Docker Image\n\nTip: If you want to build an image for a gpu version, you can use `autoraghq/autorag:gpu` or\n`autoraghq/autorag:gpu-parsing`\n\n#### 1.Download dataset for [Tutorial Step 1](https://colab.research.google.com/drive/19OEQXO_pHN6gnn2WdfPd4hjnS-4GurVd?usp=sharing)\n\n```bash\npython sample_dataset/eli5/load_eli5_dataset.py --save_path projects/tutorial_1\n```\n\n#### 2. Run `evaluate`\n\n\u003e **Note**: This step may take a long time to complete and involves OpenAI API calls, which may cost approximately $\n\u003e 0.30.\n\n```bash\ndocker run --rm -it \\\n  -v ~/.cache/huggingface:/root/.cache/huggingface \\\n  -v $(pwd)/projects:/usr/src/app/projects \\\n  -e OPENAI_API_KEY=${OPENAI_API_KEY} \\\n  autoraghq/autorag:api-latest evaluate \\\n  --config /usr/src/app/projects/tutorial_1/config.yaml \\\n  --qa_data_path /usr/src/app/projects/tutorial_1/qa_test.parquet \\\n  --corpus_data_path /usr/src/app/projects/tutorial_1/corpus.parquet \\\n  --project_dir /usr/src/app/projects/tutorial_1/\n```\n\n#### 3. Run validate\n\n```bash\ndocker run --rm -it \\\n  -v ~/.cache/huggingface:/root/.cache/huggingface \\\n  -v $(pwd)/projects:/usr/src/app/projects \\\n  -e OPENAI_API_KEY=${OPENAI_API_KEY} \\\n  autoraghq/autorag:api-latest validate \\\n  --config /usr/src/app/projects/tutorial_1/config.yaml \\\n  --qa_data_path /usr/src/app/projects/tutorial_1/qa_test.parquet \\\n  --corpus_data_path /usr/src/app/projects/tutorial_1/corpus.parquet\n```\n\n#### 4. Run `dashboard`\n\n```bash\ndocker run --rm -it \\\n  -v ~/.cache/huggingface:/root/.cache/huggingface \\\n  -v $(pwd)/projects:/usr/src/app/projects \\\n  -e OPENAI_API_KEY=${OPENAI_API_KEY} \\\n  -p 8502:8502 \\\n  autoraghq/autorag:api-latest dashboard \\\n    --trial_dir /usr/src/app/projects/tutorial_1/0\n```\n\n#### 4. Run `run_web`\n\n```bash\ndocker run --rm -it \\\n  -v ~/.cache/huggingface:/root/.cache/huggingface \\\n  -v $(pwd)/projects:/usr/src/app/projects \\\n  -e OPENAI_API_KEY=${OPENAI_API_KEY} \\\n  -p 8501:8501 \\\n  autoraghq/autorag:api-latest run_web --trial_path ./projects/tutorial_1/0\n```\n\n#### Key Points :\n\n- **`-v ~/.cache/huggingface:/cache/huggingface`**: Mounts the host machine’s Hugging Face cache to `/cache/huggingface`\n  in the container, enabling access to pre-downloaded models.\n- **`-e OPENAI_API_KEY: ${OPENAI_API_KEY}`**: Passes the `OPENAI_API_KEY` from your host environment.\n\nFor more detailed instructions, refer to\nthe [Docker Installation Guide](./docs/source/install.md#1-build-the-docker-image).\n\n## ☎️ FaQ\n\n🛣️ [Roadmap](https://github.com/orgs/Auto-RAG/projects/1/views/2)\n\n💻 [Hardware Specs](https://edai.notion.site/Hardware-specs-28cefcf2a26246ffadc91e2f3dc3d61c?pvs=4)\n\n⭐ [Running AutoRAG](https://edai.notion.site/About-running-AutoRAG-44a8058307af42068fc218a073ee480b?pvs=4)\n\n🍯 [Tips/Tricks](https://edai.notion.site/Tips-Tricks-10708a0e36ff461cb8a5d4fb3279ff15?pvs=4)\n\n☎️ [TroubleShooting](https://medium.com/@autorag/autorag-troubleshooting-5cf872b100e3)\n\n## Thanks for shoutout\n\n### Company\n\n\u003ca href=\"https://www.linkedin.com/posts/llamaindex_rag-pipelines-have-a-lot-of-hyperparameters-activity-7182053546593247232-HFMN/\"\u003e\n\u003cimg src=\"https://github.com/user-attachments/assets/b8fdaaf6-543a-4019-8dbe-44191a5269b9\" alt=\"llama index\" style=\"width:200px;height:auto;\"\u003e\n\u003c/a\u003e\n\n### Individual\n\n- [Shubham Saboo](https://www.linkedin.com/posts/shubhamsaboo_just-found-the-solution-to-the-biggest-rag-activity-7255404464054939648-ISQ8/)\n- [Kalyan KS](https://www.linkedin.com/posts/kalyanksnlp_rag-autorag-llms-activity-7258677155574788097-NgS0/)\n\n---\n\n# ✨ Contributors ✨\n\nThanks go to these wonderful people:\n\n\u003ca href=\"https://github.com/Marker-Inc-Korea/AutoRAG/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=Marker-Inc-Korea/AutoRAG\" /\u003e\n\u003c/a\u003e\n\n# Contribution\n\nWe are developing AutoRAG as open-source.\n\nSo this project welcomes contributions and suggestions. Feel free to contribute to this project.\n\nPlus, check out our detailed documentation at [here](https://docs.auto-rag.com/index.html).\n\n## Citation\n\n```bibtex\n@misc{kim2024autoragautomatedframeworkoptimization,\n      title={AutoRAG: Automated Framework for optimization of Retrieval Augmented Generation Pipeline},\n      author={Dongkyu Kim and Byoungwook Kim and Donggeon Han and Matouš Eibich},\n      year={2024},\n      eprint={2410.20878},\n      archivePrefix={arXiv},\n      primaryClass={cs.CL},\n      url={https://arxiv.org/abs/2410.20878},\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMarker-Inc-Korea%2FAutoRAG","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMarker-Inc-Korea%2FAutoRAG","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMarker-Inc-Korea%2FAutoRAG/lists"}