Junhoee commited on
Commit
d66a427
ยท
verified ยท
1 Parent(s): ca16fc0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -35
README.md CHANGED
@@ -11,24 +11,24 @@ pinned: false
11
 
12
  # Megumin RAG Chat
13
 
14
- ๋ฉ”๊ตฌ๋ฐ ํŽ˜๋ฅด์†Œ๋‚˜๋กœ ๋Œ€ํ™”ํ•˜๋Š” Gradio ๊ธฐ๋ฐ˜ ์ฑ—๋ด‡์ž…๋‹ˆ๋‹ค.
15
- Google ADK๋ฅผ ์‚ฌ์šฉํ•˜๋ฉฐ, ๋ฉ”๊ตฌ๋ฐ ์Šคํƒ€์ผ ๋ฐ์ดํ„ฐ์™€ ๋‚˜๋ฌด์œ„ํ‚ค ๊ธฐ๋ฐ˜ ์„ค์ • ๋ฐ์ดํ„ฐ๋ฅผ ํ•จ๊ป˜ ๊ฒ€์ƒ‰ํ•ด ๋‹ต๋ณ€ํ•ฉ๋‹ˆ๋‹ค.
16
 
17
- ## ํ•ต์‹ฌ ์š”์•ฝ
18
 
19
- - LLM: `gemini-3.1-flash-lite-preview`
20
- - Agent: Google ADK `LlmAgent`
21
- - ๊ฒ€์ƒ‰: Gemini Embedding + FAISS
22
- - UI: Gradio
23
- - ๋ฐ์ดํ„ฐ: ์Šคํƒ€์ผ/ํŽ˜๋ฅด์†Œ๋‚˜์šฉ + ์‚ฌ์‹ค/์„ค์ •์šฉ ์ด์ค‘ RAG
24
 
25
- ## ํ˜„์žฌ ํŠน์ง•
 
 
 
26
 
27
- - ๋ฉ”๊ตฌ๋ฐ ํŽ˜๋ฅด์†Œ๋‚˜ ์œ ์ง€
28
- - ์˜๋ฏธ ์žˆ๋Š” ์งˆ๋ฌธ๋งˆ๋‹ค RAG tool ํ˜ธ์ถœ
29
- - ์Šคํƒ€์ผ ์‚ฌ๋ก€ top-3 + ์‚ฌ์‹ค ์‚ฌ๋ก€ top-3 ๋™์‹œ ์ฐธ๊ณ 
30
- - question ์ธ๋ฑ์Šค์™€ question+answer ์ธ๋ฑ์Šค๋ฅผ ํ•จ๊ป˜ ๊ฒ€์ƒ‰
31
- - ์ตœ๊ทผ 6ํ„ด ์œ ์ง€, ๊ทธ ์ด์ „์€ ์งง์€ ์š”์•ฝ์œผ๋กœ ์••์ถ•
 
32
 
33
  ## ์‹คํ–‰
34
 
@@ -42,11 +42,9 @@ Hugging Face Spaces ์ง„์ž…์ :
42
  python app.py
43
  ```
44
 
45
- ## Hugging Face ๋ฐฐํฌ
46
-
47
- Spaces์—์„œ๋Š” ์•ฑ ์ฝ”๋“œ์™€ ๋ฐ์ดํ„ฐ์…‹ repo๋ฅผ ๋ถ„๋ฆฌํ•ด์„œ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
48
 
49
- ์•ฑ repo์—๋Š” ๋ณดํ†ต ์•„๋ž˜๋งŒ ์˜ฌ๋ฆฌ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
50
 
51
  - `app.py`
52
  - `app_gradio.py`
@@ -56,7 +54,7 @@ Spaces์—์„œ๋Š” ์•ฑ ์ฝ”๋“œ์™€ ๋ฐ์ดํ„ฐ์…‹ repo๋ฅผ ๋ถ„๋ฆฌํ•ด์„œ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
56
  - `requirements.txt`
57
  - `README.md`
58
 
59
- dataset repo์—๋Š” ์•„๋ž˜ ํŒŒ์ผ๋“ค์„ ์˜ฌ๋ฆฌ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
60
 
61
  - `megumin_qa_dataset.json`
62
  - `megumin_questions.faiss`
@@ -67,26 +65,14 @@ dataset repo์—๋Š” ์•„๋ž˜ ํŒŒ์ผ๋“ค์„ ์˜ฌ๋ฆฌ๋ฉด ๋ฉ๋‹ˆ๋‹ค.
67
  - `namuwiki_question_answer.faiss`
68
  - `namuwiki_questions_meta.json`
69
 
70
- Spaces ๋Ÿฐํƒ€์ž„์€ dataset repo์—์„œ ์œ„ ํŒŒ์ผ๋“ค์„ ๋‚ด๋ ค๋ฐ›์•„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
71
-
72
  ํ•„์ˆ˜ Secret:
73
 
74
  - `GOOGLE_API_KEY`
75
- - `HF_TOKEN` (private dataset repo ์‚ฌ์šฉ ์‹œ)
76
-
77
- ## ์ธ๋ฑ์Šค ์ƒ์„ฑ
78
-
79
- ```bash
80
- python scripts/build_faiss_index.py
81
- ```
82
-
83
- ์ด ์Šคํฌ๋ฆฝํŠธ๋Š” ์•„๋ž˜ ๋‘ ์ธ๋ฑ์Šค๋ฅผ ํ•จ๊ป˜ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.
84
 
85
- - ์Šคํƒ€์ผ ๋ฐ์ดํ„ฐ ์ธ๋ฑ์Šค
86
- - ๋‚˜๋ฌด์œ„ํ‚ค ๋ฐ์ดํ„ฐ ์ธ๋ฑ์Šค
87
 
88
- ## ์ฃผ์š” ๋ฌธ์„œ
89
-
90
- - [ADK ๊ฐœ์š”](docs/Google-ADK.md)
91
  - [๋ฐ์ดํ„ฐ ์ˆ˜์ง‘ ๋ช…์„ธ](docs/data-collection-spec.md)
92
  - [Agent ๊ตฌ์กฐ ๋ช…์„ธ](docs/agent-architecture.md)
 
 
11
 
12
  # Megumin RAG Chat
13
 
14
+ ๋ฉ”๊ตฌ๋ฐ๊ณผ ์ง์ ‘ ๋Œ€ํ™”ํ•˜๋Š” ๋А๋‚Œ์œผ๋กœ ๋งŒ๋“  ์บ๋ฆญํ„ฐ ์ฑ—๋ด‡์ž…๋‹ˆ๋‹ค.
15
+ ๋ฉ”๊ตฌ๋ฐ์˜ ๋งํˆฌ์™€ ๊ฐ์ •์„ ์„ ์œ ์ง€ํ•˜๋ฉด์„œ, ์ฝ”๋…ธ์Šค๋ฐ” ์„ค์ • ์ •๋ณด์™€ ์œ ์‚ฌ ๋Œ€ํ™” ์‚ฌ๋ก€๋ฅผ ํ•จ๊ป˜ ์ฐธ๊ณ ํ•ด ๋‹ตํ•ฉ๋‹ˆ๋‹ค.
16
 
17
+ ## ๋ฐ”๋กœ ์จ๋ณด๊ธฐ
18
 
19
+ ์ด๋Ÿฐ ์งˆ๋ฌธ์œผ๋กœ ์‹œ์ž‘ํ•ด๋ณด์„ธ์š”.
 
 
 
 
20
 
21
+ - ๋ฉ”๊ตฌ๋ฐ, ์นด์ฆˆ๋งˆ ์”จ๋ฅผ ์–ด๋–ป๊ฒŒ ์ƒ๊ฐํ•˜์‹ญ๋‹ˆ๊นŒ?
22
+ - ํญ๋ ฌ๋งˆ๋ฒ•์„ ๊ฐ€๋ฅด์ณ ์ค€ ์‚ฌ๋žŒ์€ ๋ˆ„๊ตฌ์ธ๊ฐ€์š”?
23
+ - ์•„์ฟ ์•„์˜ ์„ธ์ดํฌ๋ฆฌ๋“œ ๋ธŒ๋ ˆ์ดํฌ ์ŠคํŽ ์ด ๋ฌด์—‡์ธ์ง€ ์„ค๋ช…ํ•ด ์ฃผ์„ธ์š”.
24
+ - ํ™๋งˆ์กฑ๋‹ค์šด ์ž๊ธฐ์†Œ๊ฐœ๋ฅผ ํ•œ ๋ฒˆ ๋“ค๋ ค์ฃผ์‹œ๊ฒ ์Šต๋‹ˆ๊นŒ?
25
 
26
+ ## ์ด Space์˜ ํŠน์ง•
27
+
28
+ - ๋ฉ”๊ตฌ๋ฐ ํŽ˜๋ฅด์†Œ๋‚˜ ๊ธฐ๋ฐ˜ ๋Œ€ํ™”
29
+ - ์„ค์ • RAG + ์Šคํƒ€์ผ RAG ๋™์‹œ ์‚ฌ์šฉ
30
+ - question ์ธ๋ฑ์Šค์™€ question+answer ์ธ๋ฑ์Šค๋ฅผ ํ•จ๊ป˜ ์“ฐ๋Š” FAISS ๊ฒ€์ƒ‰
31
+ - Gradio ๊ธฐ๋ฐ˜ PC์šฉ ์ฒดํ—˜ ํŽ˜์ด์ง€
32
 
33
  ## ์‹คํ–‰
34
 
 
42
  python app.py
43
  ```
44
 
45
+ ## Hugging Face ๊ตฌ์„ฑ
 
 
46
 
47
+ ์•ฑ repo:
48
 
49
  - `app.py`
50
  - `app_gradio.py`
 
54
  - `requirements.txt`
55
  - `README.md`
56
 
57
+ dataset repo:
58
 
59
  - `megumin_qa_dataset.json`
60
  - `megumin_questions.faiss`
 
65
  - `namuwiki_question_answer.faiss`
66
  - `namuwiki_questions_meta.json`
67
 
 
 
68
  ํ•„์ˆ˜ Secret:
69
 
70
  - `GOOGLE_API_KEY`
71
+ - `HF_TOKEN`
 
 
 
 
 
 
 
 
72
 
73
+ ## ๋ฌธ์„œ
 
74
 
75
+ - [ADK ์ •๋ฆฌ](docs/Google-ADK.md)
 
 
76
  - [๋ฐ์ดํ„ฐ ์ˆ˜์ง‘ ๋ช…์„ธ](docs/data-collection-spec.md)
77
  - [Agent ๊ตฌ์กฐ ๋ช…์„ธ](docs/agent-architecture.md)
78
+