RektPunk
commited on
Commit
ยท
c330cdb
1
Parent(s):
4eefe86
[Doc] Add Korean translation for README.md (#2040)
Browse files### What problem does this PR solve?
Add Korean translation for the `README.md` file.
This translation aims to accurately convey the meaning of the original
document.
### Type of change
- [x] Documentation Update
- README.md +2 -1
- README_ja.md +2 -1
- README_ko.md +332 -0
- README_zh.md +2 -1
README.md
CHANGED
@@ -7,7 +7,8 @@
|
|
7 |
<p align="center">
|
8 |
<a href="./README.md">English</a> |
|
9 |
<a href="./README_zh.md">็ฎไฝไธญๆ</a> |
|
10 |
-
<a href="./README_ja.md">ๆฅๆฌ่ช</a>
|
|
|
11 |
</p>
|
12 |
|
13 |
<p align="center">
|
|
|
7 |
<p align="center">
|
8 |
<a href="./README.md">English</a> |
|
9 |
<a href="./README_zh.md">็ฎไฝไธญๆ</a> |
|
10 |
+
<a href="./README_ja.md">ๆฅๆฌ่ช</a> |
|
11 |
+
<a href="./README_ko.md">ํ๊ตญ์ด</a>
|
12 |
</p>
|
13 |
|
14 |
<p align="center">
|
README_ja.md
CHANGED
@@ -7,7 +7,8 @@
|
|
7 |
<p align="center">
|
8 |
<a href="./README.md">English</a> |
|
9 |
<a href="./README_zh.md">็ฎไฝไธญๆ</a> |
|
10 |
-
<a href="./README_ja.md">ๆฅๆฌ่ช</a>
|
|
|
11 |
</p>
|
12 |
|
13 |
<p align="center">
|
|
|
7 |
<p align="center">
|
8 |
<a href="./README.md">English</a> |
|
9 |
<a href="./README_zh.md">็ฎไฝไธญๆ</a> |
|
10 |
+
<a href="./README_ja.md">ๆฅๆฌ่ช</a> |
|
11 |
+
<a href="./README_ko.md">ํ๊ตญ์ด</a>
|
12 |
</p>
|
13 |
|
14 |
<p align="center">
|
README_ko.md
ADDED
@@ -0,0 +1,332 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<div align="center">
|
2 |
+
<a href="https://demo.ragflow.io/">
|
3 |
+
<img src="web/src/assets/logo-with-text.png" width="520" alt="ragflow logo">
|
4 |
+
</a>
|
5 |
+
</div>
|
6 |
+
|
7 |
+
<p align="center">
|
8 |
+
<a href="./README.md">English</a> |
|
9 |
+
<a href="./README_zh.md">็ฎไฝไธญๆ</a> |
|
10 |
+
<a href="./README_ja.md">ๆฅๆฌ่ช</a> |
|
11 |
+
<a href="./README_ko.md">ํ๊ตญ์ด</a> |
|
12 |
+
</p>
|
13 |
+
|
14 |
+
<p align="center">
|
15 |
+
<a href="https://github.com/infiniflow/ragflow/releases/latest">
|
16 |
+
<img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
|
17 |
+
</a>
|
18 |
+
<a href="https://demo.ragflow.io" target="_blank">
|
19 |
+
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
20 |
+
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
21 |
+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.9.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.9.0"></a>
|
22 |
+
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
23 |
+
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
24 |
+
</a>
|
25 |
+
</p>
|
26 |
+
|
27 |
+
<h4 align="center">
|
28 |
+
<a href="https://ragflow.io/docs/dev/">Document</a> |
|
29 |
+
<a href="https://github.com/infiniflow/ragflow/issues/162">Roadmap</a> |
|
30 |
+
<a href="https://twitter.com/infiniflowai">Twitter</a> |
|
31 |
+
<a href="https://discord.gg/4XxujFgUN7">Discord</a> |
|
32 |
+
<a href="https://demo.ragflow.io">Demo</a>
|
33 |
+
</h4>
|
34 |
+
|
35 |
+
|
36 |
+
## ๐ก RAGFlow๋?
|
37 |
+
|
38 |
+
[RAGFlow](https://ragflow.io/)๋ ์ฌ์ธต ๋ฌธ์ ์ดํด์ ๊ธฐ๋ฐํ ์คํ์์ค RAG (Retrieval-Augmented Generation) ์์ง์
๋๋ค. ์ด ์์ง์ ๋๊ท๋ชจ ์ธ์ด ๋ชจ๋ธ(LLM)๊ณผ ๊ฒฐํฉํ์ฌ ์ ํํ ์ง๋ฌธ ์๋ต ๊ธฐ๋ฅ์ ์ ๊ณตํ๋ฉฐ, ๋ค์ํ ๋ณต์กํ ํ์์ ๋ฐ์ดํฐ์์ ์ ๋ขฐํ ์ ์๋ ์ถ์ฒ๋ฅผ ๋ฐํ์ผ๋ก ํ ์ธ์ฉ์ ํตํด ์ด๋ฅผ ๋ท๋ฐ์นจํฉ๋๋ค. RAGFlow๋ ๊ท๋ชจ์ ์๊ด์์ด ๋ชจ๋ ๊ธฐ์
์ ์ต์ ํ๋ RAG ์ํฌํ๋ก์ฐ๋ฅผ ์ ๊ณตํฉ๋๋ค.
|
39 |
+
|
40 |
+
|
41 |
+
|
42 |
+
## ๐ฎ ๋ฐ๋ชจ
|
43 |
+
๋ฐ๋ชจ๋ฅผ [https://demo.ragflow.io](https://demo.ragflow.io)์์ ์คํํด ๋ณด์ธ์.
|
44 |
+
<div align="center" style="margin-top:20px;margin-bottom:20px;">
|
45 |
+
<img src="https://github.com/infiniflow/ragflow/assets/7248/2f6baa3e-1092-4f11-866d-36f6a9d075e5" width="1200"/>
|
46 |
+
<img src="https://github.com/infiniflow/ragflow/assets/12318111/b083d173-dadc-4ea9-bdeb-180d7df514eb" width="1200"/>
|
47 |
+
</div>
|
48 |
+
|
49 |
+
|
50 |
+
## ๐ฅ ์
๋ฐ์ดํธ
|
51 |
+
|
52 |
+
- 2024-08-02: [graphrag](https://github.com/microsoft/graphrag)์ ๋ง์ธ๋๋งต์์ ์๊ฐ์ ๋ฐ์ GraphRAG๋ฅผ ์ง์ํฉ๋๋ค.
|
53 |
+
|
54 |
+
- 2024-07-23: ์ค๋์ค ํ์ผ ๋ถ์์ ์ง์ํฉ๋๋ค.
|
55 |
+
|
56 |
+
- 2024-07-21: ๋ ๋ง์ LLMs(LocalAI, OpenRouter, StepFun, Nvidia)๋ฅผ ์ง์ํฉ๋๋ค.
|
57 |
+
|
58 |
+
- 2024-07-18: ๊ทธ๋ํ์ ๋ ๋ง์ ๊ตฌ์ฑ์์(Wikipedia, PubMed, Baidu, Duckduckgo)๋ฅผ ์ถ๊ฐํฉ๋๋ค.
|
59 |
+
|
60 |
+
- 2024-07-08: [Graph](./graph/README.md)๋ฅผ ๊ธฐ๋ฐ์ผ๋ก ํ ์ํฌํ๋ก์ฐ๋ฅผ ์ง์ํฉ๋๋ค.
|
61 |
+
|
62 |
+
- 2024-06-27: Q&A ๋ถ์ ๋ฐฉ๋ฒ์์ Markdown๊ณผ Docx๋ฅผ ์ง์ํฉ๋๋ค.
|
63 |
+
|
64 |
+
- 2024-06-27: Docx ํ์ผ์์ ์ด๋ฏธ์ง ์ถ์ถ์ ์ง์ํฉ๋๋ค.
|
65 |
+
|
66 |
+
- 2024-06-27: Markdown ํ์ผ์์ ํ ์ถ์ถ์ ์ง์ํฉ๋๋ค.
|
67 |
+
|
68 |
+
- 2024-06-06: ๋ํ ์ค์ ์์ ๊ธฐ๋ณธ์ผ๋ก [Self-RAG](https://huggingface.co/papers/2310.11511)๋ฅผ ์ง์ํฉ๋๋ค.
|
69 |
+
|
70 |
+
- 2024-05-30: [BCE](https://github.com/netease-youdao/BCEmbedding) ๋ฐ [BGE](https://github.com/FlagOpen/FlagEmbedding) reranker ๋ชจ๋ธ์ ํตํฉํฉ๋๋ค.
|
71 |
+
|
72 |
+
- 2024-05-23: ๋ ๋์ ํ
์คํธ ๊ฒ์์ ์ํด [RAPTOR](https://arxiv.org/html/2401.18059v1)๋ฅผ ์ง์ํฉ๋๋ค.
|
73 |
+
|
74 |
+
- 2024-05-15: OpenAI GPT-4o๋ฅผ ํตํฉํฉ๋๋ค.
|
75 |
+
|
76 |
+
|
77 |
+
## ๐ ์ฃผ์ ๊ธฐ๋ฅ
|
78 |
+
|
79 |
+
### ๐ญ **"Quality in, quality out"**
|
80 |
+
- [์ฌ์ธต ๋ฌธ์ ์ดํด](./deepdoc/README.md)๋ฅผ ๊ธฐ๋ฐ์ผ๋ก ๋ณต์กํ ํ์์ ๋น์ ํ ๋ฐ์ดํฐ์์ ์ง์์ ์ถ์ถํฉ๋๋ค.
|
81 |
+
- ๋ฌธ์ ๊ทธ๋๋ก ๋ฌดํํ ํ ํฐ์์ "๋ฐ์ดํฐ ์์ ๋ฐ๋"์ ์ฐพ์๋
๋๋ค.
|
82 |
+
|
83 |
+
### ๐ฑ **ํ
ํ๋ฆฟ ๊ธฐ๋ฐ์ chunking**
|
84 |
+
- ๋๋ํ๊ณ ์ค๋ช
๊ฐ๋ฅํ ๋ฐฉ์.
|
85 |
+
- ๋ค์ํ ํ
ํ๋ฆฟ ์ต์
์ ์ ๊ณตํฉ๋๋ค.
|
86 |
+
|
87 |
+
|
88 |
+
### ๐ฑ **ํ ๋ฃจ์๋ค์ด์
์ ์ค์ธ ์ ๋ขฐํ ์ ์๋ ์ธ์ฉ**
|
89 |
+
- ํ
์คํธ ์ฒญํน์ ์๊ฐํํ์ฌ ์ฌ์ฉ์๊ฐ ๊ฐ์
ํ ์ ์๋๋ก ํฉ๋๋ค.
|
90 |
+
- ์ค์ํ ์ฐธ๊ณ ์๋ฃ์ ์ถ์ ๊ฐ๋ฅํ ์ธ์ฉ์ ๋น ๋ฅด๊ฒ ํ์ธํ์ฌ ์ ๋ขฐํ ์ ์๋ ๋ต๋ณ์ ์ง์ํฉ๋๋ค.
|
91 |
+
|
92 |
+
|
93 |
+
### ๐ **๋ค๋ฅธ ์ข
๋ฅ์ ๋ฐ์ดํฐ ์์ค์์ ํธํ์ฑ**
|
94 |
+
- ์๋, ์ฌ๋ผ์ด๋, ์์
, ํ
์คํธ ํ์ผ, ์ด๋ฏธ์ง, ์ค์บ๋ณธ, ๊ตฌ์กฐํ๋ ๋ฐ์ดํฐ, ์น ํ์ด์ง ๋ฑ์ ์ง์ํฉ๋๋ค.
|
95 |
+
|
96 |
+
### ๐ **์๋ํ๋๊ณ ์์ฌ์ด RAG ์ํฌํ๋ก์ฐ**
|
97 |
+
- ๊ฐ์ธ ๋ฐ ๋๊ท๋ชจ ๋น์ฆ๋์ค์ ๋ง์ถ ํจ์จ์ ์ธ RAG ์ค์ผ์คํธ๋ ์ด์
.
|
98 |
+
- ๊ตฌ์ฑ ๊ฐ๋ฅํ LLM ๋ฐ ์๋ฒ ๋ฉ ๋ชจ๋ธ.
|
99 |
+
- ๋ค์ค ๊ฒ์๊ณผ ๊ฒฐํฉ๋ re-ranking.
|
100 |
+
- ๋น์ฆ๋์ค์ ์ํํ๊ฒ ํตํฉํ ์ ์๋ ์ง๊ด์ ์ธ API.
|
101 |
+
|
102 |
+
|
103 |
+
## ๐ ์์คํ
์ํคํ
์ฒ
|
104 |
+
|
105 |
+
<div align="center" style="margin-top:20px;margin-bottom:20px;">
|
106 |
+
<img src="https://github.com/infiniflow/ragflow/assets/12318111/d6ac5664-c237-4200-a7c2-a4a00691b485" width="1000"/>
|
107 |
+
</div>
|
108 |
+
|
109 |
+
## ๐ฌ ์์ํ๊ธฐ
|
110 |
+
### ๐ ์ฌ์ ์ค๋น ์ฌํญ
|
111 |
+
- CPU >= 4 cores
|
112 |
+
- RAM >= 16 GB
|
113 |
+
- Disk >= 50 GB
|
114 |
+
- Docker >= 24.0.0 & Docker Compose >= v2.26.1
|
115 |
+
> ๋ก์ปฌ ๋จธ์ (Windows, Mac, Linux)์ Docker๊ฐ ์ค์น๋์ง ์์ ๊ฒฝ์ฐ, [Docker ์์ง ์ค์น]((https://docs.docker.com/engine/install/))๋ฅผ ์ฐธ์กฐํ์ธ์.
|
116 |
+
|
117 |
+
|
118 |
+
### ๐ ์๋ฒ ์์ํ๊ธฐ
|
119 |
+
|
120 |
+
1. `vm.max_map_count`๊ฐ 262144 ์ด์์ธ์ง ํ์ธํ์ธ์:
|
121 |
+
> `vm.max_map_count`์ ๊ฐ์ ์๋ ๋ช
๋ น์ด๋ฅผ ํตํด ํ์ธํ์ธ์:
|
122 |
+
>
|
123 |
+
> ```bash
|
124 |
+
> $ sysctl vm.max_map_count
|
125 |
+
> ```
|
126 |
+
>
|
127 |
+
> ๋ง์ฝ `vm.max_map_count` ์ด 262144 ๋ณด๋ค ์๋ค๋ฉด ๊ฐ์ ์์ค์ ํ์ธ์.
|
128 |
+
>
|
129 |
+
> ```bash
|
130 |
+
> # ์ด ๊ฒฝ์ฐ์ 262144๋ก ์ค์ ํ์ต๋๋ค.:
|
131 |
+
> $ sudo sysctl -w vm.max_map_count=262144
|
132 |
+
> ```
|
133 |
+
>
|
134 |
+
> ์ด ๋ณ๊ฒฝ ์ฌํญ์ ์์คํ
์ฌ๋ถํ
ํ์ ์ด๊ธฐํ๋ฉ๋๋ค. ๋ณ๊ฒฝ ์ฌํญ์ ์๊ตฌ์ ์ผ๋ก ์ ์ฉํ๋ ค๋ฉด /etc/sysctl.conf ํ์ผ์ vm.max_map_count ๊ฐ์ ์ถ๊ฐํ๊ฑฐ๋ ์
๋ฐ์ดํธํ์ธ์:
|
135 |
+
>
|
136 |
+
> ```bash
|
137 |
+
> vm.max_map_count=262144
|
138 |
+
> ```
|
139 |
+
|
140 |
+
2. ๋ ํฌ์งํ ๋ฆฌ๋ฅผ ํด๋ก ํ์ธ์:
|
141 |
+
|
142 |
+
```bash
|
143 |
+
$ git clone https://github.com/infiniflow/ragflow.git
|
144 |
+
```
|
145 |
+
|
146 |
+
3. ๋ฏธ๋ฆฌ ๋น๋๋ Docker ์ด๋ฏธ์ง๋ฅผ ์์ฑํ๊ณ ์๋ฒ๋ฅผ ์์ํ์ธ์:
|
147 |
+
|
148 |
+
> ๋ค์ ๋ช
๋ น์ด๋ฅผ ์คํํ๋ฉด *dev* ๋ฒ์ ์ RAGFlow Docker ์ด๋ฏธ์ง๊ฐ ์๋์ผ๋ก ๋ค์ด๋ก๋๋ฉ๋๋ค. ํน์ Docker ๋ฒ์ ์ ๋ค์ด๋ก๋ํ๊ณ ์คํํ๋ ค๋ฉด, **docker/.env** ํ์ผ์์ `RAGFLOW_VERSION`์ ์ํ๋ ๋ฒ์ ์ผ๋ก ์
๋ฐ์ดํธํ ํ, ์๋ฅผ ๋ค์ด `RAGFLOW_VERSION=v0.9.0`๋ก ์
๋ฐ์ดํธ ํ ๋ค, ๋ค์ ๋ช
๋ น์ด๋ฅผ ์คํํ์ธ์.
|
149 |
+
```bash
|
150 |
+
$ cd ragflow/docker
|
151 |
+
$ chmod +x ./entrypoint.sh
|
152 |
+
$ docker compose up -d
|
153 |
+
```
|
154 |
+
|
155 |
+
> ๊ธฐ๋ณธ ์ด๋ฏธ์ง๋ ์ฝ 9GB ํฌ๊ธฐ์ด๋ฉฐ ๋ก๋ํ๋ ๋ฐ ์๊ฐ์ด ๊ฑธ๋ฆด ์ ์์ต๋๋ค.
|
156 |
+
|
157 |
+
|
158 |
+
4. ์๋ฒ๊ฐ ์์๋ ํ ์๋ฒ ์ํ๋ฅผ ํ์ธํ์ธ์:
|
159 |
+
|
160 |
+
```bash
|
161 |
+
$ docker logs -f ragflow-server
|
162 |
+
```
|
163 |
+
|
164 |
+
_๋ค์ ์ถ๋ ฅ ๊ฒฐ๊ณผ๋ก ์์คํ
์ด ์ฑ๊ณต์ ์ผ๋ก ์์๋์์์ ํ์ธํฉ๋๋ค:_
|
165 |
+
|
166 |
+
```bash
|
167 |
+
____ ______ __
|
168 |
+
/ __ \ ____ _ ____ _ / ____// /____ _ __
|
169 |
+
/ /_/ // __ `// __ `// /_ / // __ \| | /| / /
|
170 |
+
/ _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ /
|
171 |
+
/_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/
|
172 |
+
/____/
|
173 |
+
|
174 |
+
* Running on all addresses (0.0.0.0)
|
175 |
+
* Running on http://127.0.0.1:9380
|
176 |
+
* Running on http://x.x.x.x:9380
|
177 |
+
INFO:werkzeug:Press CTRL+C to quit
|
178 |
+
```
|
179 |
+
> ๋ง์ฝ ํ์ธ ๋จ๊ณ๋ฅผ ๊ฑด๋๋ฐ๊ณ ๋ฐ๋ก RAGFlow์ ๋ก๊ทธ์ธํ๋ฉด, RAGFlow๊ฐ ์์ ํ ์ด๊ธฐํ๋์ง ์์๊ธฐ ๋๋ฌธ์ ๋ธ๋ผ์ฐ์ ์์ `network anomaly` ์ค๋ฅ๊ฐ ๋ฐ์ํ ์ ์์ต๋๋ค.
|
180 |
+
|
181 |
+
5. ์น ๋ธ๋ผ์ฐ์ ์ ์๋ฒ์ IP ์ฃผ์๋ฅผ ์
๋ ฅํ๊ณ RAGFlow์ ๋ก๊ทธ์ธํ์ธ์.
|
182 |
+
> ๊ธฐ๋ณธ ์ค์ ์ ์ฌ์ฉํ ๊ฒฝ์ฐ, `http://IP_OF_YOUR_MACHINE`๋ง ์
๋ ฅํ๋ฉด ๋ฉ๋๋ค (ํฌํธ ๋ฒํธ๋ ์ ์ธ). ๊ธฐ๋ณธ HTTP ์๋น์ค ํฌํธ `80`์ ๊ธฐ๋ณธ ๊ตฌ์ฑ์ผ๋ก ์ฌ์ฉํ ๋ ์๋ตํ ์ ์์ต๋๋ค.
|
183 |
+
6. [service_conf.yaml](./docker/service_conf.yaml) ํ์ผ์์ ์ํ๋ LLM ํฉํ ๋ฆฌ๋ฅผ `user_default_llm`์ ์ ํํ๊ณ , `API_KEY` ํ๋๋ฅผ ํด๋น API ํค๋ก ์
๋ฐ์ดํธํ์ธ์.
|
184 |
+
> ์์ธํ ๋ด์ฉ์ [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup)๋ฅผ ์ฐธ์กฐํ์ธ์.
|
185 |
+
|
186 |
+
_์ด์ ์ผ๊ฐ ์์๋ฉ๋๋ค!_
|
187 |
+
|
188 |
+
## ๐ง ์ค์
|
189 |
+
|
190 |
+
์์คํ
์ค์ ๊ณผ ๊ด๋ จํ์ฌ ๋ค์ ํ์ผ๋ค์ ๊ด๋ฆฌํด์ผ ํฉ๋๋ค:
|
191 |
+
|
192 |
+
- [.env](./docker/.env): `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, `MINIO_PASSWORD`์ ๊ฐ์ ์์คํ
์ ๊ธฐ๋ณธ ์ค์ ์ ํฌํจํฉ๋๋ค.
|
193 |
+
- [service_conf.yaml](./docker/service_conf.yaml): ๋ฐฑ์๋ ์๋น์ค๋ฅผ ๊ตฌ์ฑํฉ๋๋ค.
|
194 |
+
- [docker-compose.yml](./docker/docker-compose.yml): ์์คํ
์ [docker-compose.yml](./docker/docker-compose.yml)์ ์ฌ์ฉํ์ฌ ์์๋ฉ๋๋ค.
|
195 |
+
|
196 |
+
[.env](./docker/.env) ํ์ผ์ ๋ณ๊ฒฝ ์ฌํญ์ด [service_conf.yaml](./docker/service_conf.yaml) ํ์ผ์ ๋ด์ฉ๊ณผ ์ผ์นํ๋๋ก ํด์ผ ํฉ๋๋ค.
|
197 |
+
|
198 |
+
> [./docker/README](./docker/README.md) ํ์ผ์๋ ํ๊ฒฝ ์ค์ ๊ณผ ์๋น์ค ๊ตฌ์ฑ์ ๋ํ ์์ธํ ์ค๋ช
์ด ์์ผ๋ฉฐ, [./docker/README](./docker/README.md) ํ์ผ์ ๋์ด๋ ๋ชจ๋ ํ๊ฒฝ ์ค์ ์ด [service_conf.yaml](./docker/service_conf.yaml) ํ์ผ์ ํด๋น ๊ตฌ์ฑ๊ณผ ์ผ์นํ๋๋ก ํด์ผ ํฉ๋๋ค.
|
199 |
+
|
200 |
+
๊ธฐ๋ณธ HTTP ์๋น์ค ํฌํธ(80)๋ฅผ ์
๋ฐ์ดํธํ๋ ค๋ฉด [docker-compose.yml](./docker/docker-compose.yml) ํ์ผ์์ `80:80`์ `<YOUR_SERVING_PORT>:80`์ผ๋ก ๋ณ๊ฒฝํ์ธ์.
|
201 |
+
|
202 |
+
> ๋ชจ๋ ์์คํ
๊ตฌ์ฑ ์
๋ฐ์ดํธ๋ ์ ์ฉ๋๊ธฐ ์ํด ์์คํ
์ฌ๋ถํ
์ด ํ์ํฉ๋๋ค.
|
203 |
+
>
|
204 |
+
> ```bash
|
205 |
+
> $ docker-compose up -d
|
206 |
+
> ```
|
207 |
+
|
208 |
+
## ๐ ๏ธ ์์ค์์ ๋น๋ํ๊ธฐ
|
209 |
+
|
210 |
+
Docker ์ด๋ฏธ์ง๋ฅผ ์์ค์์ ๋น๋ํ๋ ค๋ฉด:
|
211 |
+
|
212 |
+
```bash
|
213 |
+
$ git clone https://github.com/infiniflow/ragflow.git
|
214 |
+
$ cd ragflow/
|
215 |
+
$ docker build -t infiniflow/ragflow:dev .
|
216 |
+
$ cd ragflow/docker
|
217 |
+
$ chmod +x ./entrypoint.sh
|
218 |
+
$ docker compose up -d
|
219 |
+
```
|
220 |
+
|
221 |
+
|
222 |
+
## ๐ ๏ธ ์์ค์์ ์๋น์ค ์์ํ๊ธฐ
|
223 |
+
|
224 |
+
์๋น์ค๋ฅผ ์์ค์์ ์์ํ๋ ค๋ฉด:
|
225 |
+
|
226 |
+
1. ๋ ํฌ์งํ ๋ฆฌ๋ฅผ ํด๋ก ํ์ธ์:
|
227 |
+
|
228 |
+
```bash
|
229 |
+
$ git clone https://github.com/infiniflow/ragflow.git
|
230 |
+
$ cd ragflow/
|
231 |
+
```
|
232 |
+
|
233 |
+
2. ๊ฐ์ ํ๊ฒฝ์ ์์ฑํ๊ณ , Anaconda ๋๋ Miniconda๊ฐ ์ค์น๋์ด ์๋์ง ํ์ธํ์ธ์:
|
234 |
+
```bash
|
235 |
+
$ conda create -n ragflow python=3.11.0
|
236 |
+
$ conda activate ragflow
|
237 |
+
$ pip install -r requirements.txt
|
238 |
+
```
|
239 |
+
|
240 |
+
```bash
|
241 |
+
# CUDA ๋ฒ์ ์ด 12.0๋ณด๋ค ๋์ ๊ฒฝ์ฐ, ๋ค์ ๋ช
๋ น์ด๋ฅผ ์ถ๊ฐ๋ก ์คํํ์ธ์:
|
242 |
+
$ pip uninstall -y onnxruntime-gpu
|
243 |
+
$ pip install onnxruntime-gpu --extra-index-url https://aiinfra.pkgs.visualstudio.com/PublicPackages/_packaging/onnxruntime-cuda-12/pypi/simple/
|
244 |
+
```
|
245 |
+
|
246 |
+
3. ์ง์
์คํฌ๋ฆฝํธ๋ฅผ ๋ณต์ฌํ๊ณ ํ๊ฒฝ ๋ณ์๋ฅผ ์ค์ ํ์ธ์:
|
247 |
+
```bash
|
248 |
+
# ํ์ด์ฌ ๊ฒฝ๋ก๋ฅผ ๋ฐ์์ต๋๋ค:
|
249 |
+
$ which python
|
250 |
+
# RAGFlow ํ๋ก์ ํธ ๊ฒฝ๋ก๋ฅผ ๋ฐ์์ต๋๋ค:
|
251 |
+
$ pwd
|
252 |
+
```
|
253 |
+
|
254 |
+
```bash
|
255 |
+
$ cp docker/entrypoint.sh .
|
256 |
+
$ vi entrypoint.sh
|
257 |
+
```
|
258 |
+
|
259 |
+
```bash
|
260 |
+
# ์ค์ ์ํฉ์ ๋ง๊ฒ ์ค์ ์กฐ์ ํ๊ธฐ (๋ค์ ๋ ๊ฐ์ export ๋ช
๋ น์ด๋ ์๋ก ์ถ๊ฐ๋์์ต๋๋ค):
|
261 |
+
# - `which python`์ ๊ฒฐ๊ณผ๋ฅผ `PY`์ ํ ๋นํฉ๋๋ค.
|
262 |
+
# - `pwd`์ ๊ฒฐ๊ณผ๋ฅผ `PYTHONPATH`์ ํ ๋นํฉ๋๋ค.
|
263 |
+
# - `LD_LIBRARY_PATH`๊ฐ ์ค์ ๋์ด ์๋ ๊ฒฝ์ฐ ์ฃผ์ ์ฒ๋ฆฌํฉ๋๋ค.
|
264 |
+
# - ์ ํ ์ฌํญ: Hugging Face ๋ฏธ๋ฌ ์ถ๊ฐ.
|
265 |
+
PY=${PY}
|
266 |
+
export PYTHONPATH=${PYTHONPATH}
|
267 |
+
export HF_ENDPOINT=https://hf-mirror.com
|
268 |
+
```
|
269 |
+
|
270 |
+
4. ๋ค๋ฅธ ์๋น์ค(MinIO, Elasticsearch, Redis, MySQL)๋ฅผ ์์ํ์ธ์:
|
271 |
+
```bash
|
272 |
+
$ cd docker
|
273 |
+
$ docker compose -f docker-compose-base.yml up -d
|
274 |
+
```
|
275 |
+
|
276 |
+
5. ์ค์ ํ์ผ์ ํ์ธํ์ฌ ๋ค์ ์ฌํญ์ ํ์ธํ์ธ์:
|
277 |
+
- **docker/.env**์ ์ค์ ์ด **conf/service_conf.yaml**์ ์ค์ ๊ณผ ์ผ์นํ๋์ง ํ์ธํฉ๋๋ค.
|
278 |
+
- **service_conf.yaml**์ ๊ด๋ จ ์๋น์ค์ ๋ํ IP ์ฃผ์์ ํฌํธ๊ฐ ๋ก์ปฌ ๋จธ์ ์ IP ์ฃผ์์ ์ปจํ
์ด๋์์ ๋
ธ์ถ๋ ํฌํธ์ ์ผ์นํ๋์ง ํ์ธํฉ๋๋ค.
|
279 |
+
|
280 |
+
|
281 |
+
6. RAGFlow ๋ฐฑ์๋ ์๋น์ค๋ฅผ ์์ํฉ๋๋ค:
|
282 |
+
|
283 |
+
```bash
|
284 |
+
$ chmod +x ./entrypoint.sh
|
285 |
+
$ bash ./entrypoint.sh
|
286 |
+
```
|
287 |
+
|
288 |
+
7. ํ๋ก ํธ์๋ ์๋น์ค๋ฅผ ์์ํฉ๋๋ค:
|
289 |
+
|
290 |
+
```bash
|
291 |
+
$ cd web
|
292 |
+
$ npm install --registry=https://registry.npmmirror.com --force
|
293 |
+
$ vim .umirc.ts
|
294 |
+
# proxy.target์ http://127.0.0.1:9380๋ก ์
๋ฐ์ดํธํฉ๋๋ค.
|
295 |
+
$ npm run dev
|
296 |
+
```
|
297 |
+
|
298 |
+
8. ํ๋ก ํธ์๋ ์๋น์ค๋ฅผ ๋ฐฐํฌํฉ๋๋ค:
|
299 |
+
|
300 |
+
```bash
|
301 |
+
$ cd web
|
302 |
+
$ npm install --registry=https://registry.npmmirror.com --force
|
303 |
+
$ umi build
|
304 |
+
$ mkdir -p /ragflow/web
|
305 |
+
$ cp -r dist /ragflow/web
|
306 |
+
$ apt install nginx -y
|
307 |
+
$ cp ../docker/nginx/proxy.conf /etc/nginx
|
308 |
+
$ cp ../docker/nginx/nginx.conf /etc/nginx
|
309 |
+
$ cp ../docker/nginx/ragflow.conf /etc/nginx/conf.d
|
310 |
+
$ systemctl start nginx
|
311 |
+
```
|
312 |
+
|
313 |
+
## ๐ ๋ฌธ์
|
314 |
+
|
315 |
+
- [Quickstart](https://ragflow.io/docs/dev/)
|
316 |
+
- [User guide](https://ragflow.io/docs/dev/category/user-guides)
|
317 |
+
- [References](https://ragflow.io/docs/dev/category/references)
|
318 |
+
- [FAQ](https://ragflow.io/docs/dev/faq)
|
319 |
+
|
320 |
+
## ๐ ๋ก๋๋งต
|
321 |
+
|
322 |
+
[RAGFlow ๋ก๋๋งต 2024](https://github.com/infiniflow/ragflow/issues/162)์ ํ์ธํ์ธ์.
|
323 |
+
|
324 |
+
## ๐ ์ปค๋ฎค๋ํฐ
|
325 |
+
|
326 |
+
- [Discord](https://discord.gg/4XxujFgUN7)
|
327 |
+
- [Twitter](https://twitter.com/infiniflowai)
|
328 |
+
- [GitHub Discussions](https://github.com/orgs/infiniflow/discussions)
|
329 |
+
|
330 |
+
## ๐ ์ปจํธ๋ฆฌ๋ทฐ์
|
331 |
+
|
332 |
+
RAGFlow๋ ์คํ์์ค ํ์
์ ํตํด ๋ฐ์ ํฉ๋๋ค. ์ด๋ฌํ ์ ์ ์ ๋ฐํ์ผ๋ก, ์ฐ๋ฆฌ๋ ์ปค๋ฎค๋ํฐ์ ๋ค์ํ ๊ธฐ์ฌ๋ฅผ ํ์ํฉ๋๋ค. ์ฐธ์ฌํ๊ณ ์ถ์ผ์๋ค๋ฉด, ๋จผ์ [๊ฐ์ด๋๋ผ์ธ](./docs/references/CONTRIBUTING.md)์ ๊ฒํ ํด ์ฃผ์ธ์.
|
README_zh.md
CHANGED
@@ -7,7 +7,8 @@
|
|
7 |
<p align="center">
|
8 |
<a href="./README.md">English</a> |
|
9 |
<a href="./README_zh.md">็ฎไฝไธญๆ</a> |
|
10 |
-
<a href="./README_ja.md">ๆฅๆฌ่ช</a>
|
|
|
11 |
</p>
|
12 |
|
13 |
<p align="center">
|
|
|
7 |
<p align="center">
|
8 |
<a href="./README.md">English</a> |
|
9 |
<a href="./README_zh.md">็ฎไฝไธญๆ</a> |
|
10 |
+
<a href="./README_ja.md">ๆฅๆฌ่ช</a> |
|
11 |
+
<a href="./README_ko.md">ํ๊ตญ์ด</a>
|
12 |
</p>
|
13 |
|
14 |
<p align="center">
|