Initial Commit

README.md

@@ -4,20 +4,6 @@ AutoRAG Dashboard는 실험 결과를 시각화하여 분석할 수 있는 웹
 
 ---
 
-## **🚀 주요 기능**
-### ✅ **1. 실험 결과 요약**
-- **실험 폴더 (`trial_dir`)를 자동으로 분석**하여 실험 결과를 요약합니다.
-- `summary.csv`를 기반으로 가장 성능이 좋은 모듈을 자동으로 선택합니다.
-- 실험에 사용된 설정 파일(`config.yaml`)을 Markdown 형식으로 출력합니다.
-
-### ✅ **2. 실험별 성능 비교**
-- Stripplot 및 Boxplot을 제공하여 **모듈별 성능 분포를 시각적으로 비교**할 수 있습니다.
-- 성능 비교를 통해 실험 결과를 더욱 직관적으로 이해할 수 있습니다.
-
-### ✅ **3. 개별 쿼리 조회**
-- `detail` 버튼을 클릭하여 쿼리 별로 자세한 정보를를 제공합니다.
----
-
 ## **📥 설치 및 실행 방법**
 ### **1️⃣ Docker 컨테이너 실행 (권장)**
 AutoRAG Dashboard는 Docker 환경에서 쉽게 실행할 수 있습니다.
@@ -47,8 +33,7 @@ docker compose up
 ├── docker-compose.yml  # Docker 설정 파일
 ├── Dockerfile          # Docker 빌드 파일
 ├── pyproject.toml      # Python 패키지 설정
-├── requirements.txt    # 필수 패키지 목록
-└── projects/           # 실험 결과 저장 폴더 (볼륨 마운트)
+└── requirements.txt    # 필수 패키지 목록
 ```
 
 ---
@@ -58,13 +43,34 @@ docker compose up
 기본적으로 **7690번 포트**에서 실행됩니다.  
 포트를 변경하려면 `docker-compose.yml`에서 아래 내용을 수정하세요.
 ```yaml
-    ports:
-      - "7690:7690"  # 변경하고 싶은 포트로 수정 가능
+# docker-compose.yml
+ports:
+  - "7690:7690"
+```
+```shell
+# dashboard.sh
+python3 -m autorag.cli dashboard \
+    --port 7690
 ```
 
 ### **📍 실험 데이터 경로 변경**
-실험 결과 폴더(`trial_dir`)의 기본 위치는 `./projects/benchmark_sample`입니다.  
+대시보드 실행 테스트를 위해 `./example` 폴더를 제공합니다.  
 다른 폴더를 사용하려면 실행 시 `--trial_dir` 옵션 경로를 수정하세요.
 ```bash
-python3 -m autorag.cli dashboard --trial_dir ./projects/custom_experiment
-```
+python3 -m autorag.cli dashboard \
+    --trial_dir ./projects/custom_experiment
+```
+
+---
+## **🚀 주요 기능**
+### ✅ **1. 실험 결과 요약**
+- **실험 폴더 (`trial_dir`)를 자동으로 분석**하여 실험 결과를 요약합니다.
+- `summary.csv`를 기반으로 가장 성능이 좋은 모듈을 자동으로 선택합니다.
+- 실험에 사용된 설정 파일(`config.yaml`)을 Markdown 형식으로 출력합니다.
+
+### ✅ **2. 실험별 성능 비교**
+- Stripplot 및 Boxplot을 제공하여 **모듈별 성능 분포를 시각적으로 비교**할 수 있습니다.
+- 성능 비교를 통해 실험 결과를 더욱 직관적으로 이해할 수 있습니다.
+
+### ✅ **3. 개별 쿼리 조회**
+- `detail` 버튼을 클릭하여 쿼리 별로 자세한 정보를를 제공합니다.