aboutmydreams commited on
Commit
9c89a70
·
1 Parent(s): 9e27b49

doc: fix zh and ja document type (#2012)

Browse files

### What problem does this PR solve?

- Fix zh and ja document types to allow users to read better


### Type of change

- [ ] Bug Fix (non-breaking change which fixes an issue)
- [ ] New Feature (non-breaking change which adds functionality)
- [x] Documentation Update
- [ ] Refactoring
- [ ] Performance Improvement
- [ ] Other (please describe):

Files changed (2) hide show
  1. README_ja.md +7 -7
  2. README_zh.md +15 -7
README_ja.md CHANGED
@@ -236,21 +236,21 @@ $ pip install onnxruntime-gpu --extra-index-url https://aiinfra.pkgs.visualstudi
236
  $ cp docker/entrypoint.sh .
237
  $ vi entrypoint.sh
238
  ```
239
- 以下のコマンドでPythonのパスとragflowプロジェクトのパスを取得します:
240
  ```bash
241
  $ which python
242
  $ pwd
243
  ```
244
 
245
- `which python`の出力を`PY`の値として、`pwd`の出力を`PYTHONPATH`の値として設定します。
246
 
247
- `LD_LIBRARY_PATH`が既に設定されている場合は、コメントアウトできます。
248
 
249
  ```bash
250
- # 実際の状況に応じて設定を調整してください。以下の二つのexportは新たに追加された設定です
251
  PY=${PY}
252
  export PYTHONPATH=${PYTHONPATH}
253
- # オプション:Hugging Faceミラーを追加
254
  export HF_ENDPOINT=https://hf-mirror.com
255
  ```
256
 
@@ -261,7 +261,7 @@ $ docker compose -f docker-compose-base.yml up -d
261
  ```
262
 
263
  5. 設定ファイルを確認します
264
- **docker/.env**内の設定が**conf/service_conf.yaml**内の設定と一致していることを確認してください。**service_conf.yaml**内の関連サービスのIPアドレスとポートは、ローカルマシンのIPアドレスとコンテナが公開するポートに変更する必要があります。
265
 
266
  6. サービスを起動します
267
  ```bash
@@ -288,4 +288,4 @@ $ bash ./entrypoint.sh
288
 
289
  ## 🙌 コントリビュート
290
 
291
- RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず[コントリビューションガイド](./docs/references/CONTRIBUTING.md)をご覧ください。
 
236
  $ cp docker/entrypoint.sh .
237
  $ vi entrypoint.sh
238
  ```
239
+ 以下のコマンドで Python のパスとragflowプロジェクトのパスを取得します:
240
  ```bash
241
  $ which python
242
  $ pwd
243
  ```
244
 
245
+ `which python` の出力を `PY` の値として、`pwd` の出力を `PYTHONPATH` の値として設定します。
246
 
247
+ `LD_LIBRARY_PATH` が既に設定されている場合は、コメントアウトできます。
248
 
249
  ```bash
250
+ # 実際の状況に応じて設定を調整してください。以下の二つの export は新たに追加された設定です
251
  PY=${PY}
252
  export PYTHONPATH=${PYTHONPATH}
253
+ # オプション:Hugging Face ミラーを追加
254
  export HF_ENDPOINT=https://hf-mirror.com
255
  ```
256
 
 
261
  ```
262
 
263
  5. 設定ファイルを確認します
264
+ **docker/.env** 内の設定が**conf/service_conf.yaml**内の設定と一致していることを確認してください。**service_conf.yaml**内の関連サービスのIPアドレスとポートは、ローカルマシンのIPアドレスとコンテナが公開するポートに変更する必要があります。
265
 
266
  6. サービスを起動します
267
  ```bash
 
288
 
289
  ## 🙌 コントリビュート
290
 
291
+ RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず [コントリビューションガイド](./docs/references/CONTRIBUTING.md)をご覧ください。
README_zh.md CHANGED
@@ -51,7 +51,7 @@
51
  - 2024-07-21 支持更多的大模型供应商(LocalAI/OpenRouter/StepFun/Nvidia)。
52
  - 2024-07-18 在Graph中支持算子:Wikipedia、PubMed、Baidu和Duckduckgo。
53
  - 2024-07-08 支持 Agentic RAG: 基于 [Graph](./graph/README.md) 的工作流。
54
- - 2024-06-27 Q&A 解析方式支持 Markdown 文件和 Docx 文件。
55
  - 2024-06-27 支持提取出 Docx 文件中的图片。
56
  - 2024-06-27 支持提取出 Markdown 文件中的表格。
57
  - 2024-06-06 支持 [Self-RAG](https://huggingface.co/papers/2310.11511) ,在对话设置里面默认勾选。
@@ -213,24 +213,27 @@ $ docker compose up -d
213
  如需从源码启动服务,请参考以下步骤:
214
 
215
  1. 克隆仓库
 
216
  ```bash
217
  $ git clone https://github.com/infiniflow/ragflow.git
218
  $ cd ragflow/
219
  ```
220
 
221
  2. 创建虚拟环境(确保已安装 Anaconda 或 Miniconda)
 
222
  ```bash
223
  $ conda create -n ragflow python=3.11.0
224
  $ conda activate ragflow
225
  $ pip install -r requirements.txt
226
  ```
227
- 如果cuda > 12.0,需额外执行以下命令:
228
  ```bash
229
  $ pip uninstall -y onnxruntime-gpu
230
  $ pip install onnxruntime-gpu --extra-index-url https://aiinfra.pkgs.visualstudio.com/PublicPackages/_packaging/onnxruntime-cuda-12/pypi/simple/
231
  ```
232
 
233
  3. 拷贝入口脚本并配置环境变量
 
234
  ```bash
235
  $ cp docker/entrypoint.sh .
236
  $ vi entrypoint.sh
@@ -241,19 +244,20 @@ $ which python
241
  $ pwd
242
  ```
243
 
244
- 将上述`which python`的输出作为`PY`的值,将`pwd`的输出作为`PYTHONPATH`的值。
245
 
246
- `LD_LIBRARY_PATH`如果环境已经配置好,可以注释掉。
247
 
248
  ```bash
249
- # 此处配置需要按照实际情况调整,两个export为新增配置
250
  PY=${PY}
251
  export PYTHONPATH=${PYTHONPATH}
252
- # 可选:添加Hugging Face镜像
253
  export HF_ENDPOINT=https://hf-mirror.com
254
  ```
255
 
256
  4. 启动基础服务
 
257
  ```bash
258
  $ cd docker
259
  $ docker compose -f docker-compose-base.yml up -d
@@ -263,11 +267,14 @@ $ docker compose -f docker-compose-base.yml up -d
263
  确保**docker/.env**中的配置与**conf/service_conf.yaml**中配置一致, **service_conf.yaml**中相关服务的IP地址与端口应该改成本机IP地址及容器映射出来的端口。
264
 
265
  6. 启动服务
 
266
  ```bash
267
  $ chmod +x ./entrypoint.sh
268
  $ bash ./entrypoint.sh
269
  ```
 
270
  7. 启动WebUI服务
 
271
  ```bash
272
  $ cd web
273
  $ npm install --registry=https://registry.npmmirror.com --force
@@ -277,6 +284,7 @@ $ npm run dev
277
  ```
278
 
279
  8. 部署WebUI服务
 
280
  ```bash
281
  $ cd web
282
  $ npm install --registry=https://registry.npmmirror.com --force
@@ -308,7 +316,7 @@ $ systemctl start nginx
308
 
309
  ## 🙌 贡献指南
310
 
311
- RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们欢迎来自社区的各种贡献。如果您有意参与其中,请查阅我们的[贡献者指南](./docs/references/CONTRIBUTING.md) 。
312
 
313
  ## 🤝 商务合作
314
 
 
51
  - 2024-07-21 支持更多的大模型供应商(LocalAI/OpenRouter/StepFun/Nvidia)。
52
  - 2024-07-18 在Graph中支持算子:Wikipedia、PubMed、Baidu和Duckduckgo。
53
  - 2024-07-08 支持 Agentic RAG: 基于 [Graph](./graph/README.md) 的工作流。
54
+ - 2024-06-27 Q&A 解析方式支持 Markdown 文件和 Docx 文件。
55
  - 2024-06-27 支持提取出 Docx 文件中的图片。
56
  - 2024-06-27 支持提取出 Markdown 文件中的表格。
57
  - 2024-06-06 支持 [Self-RAG](https://huggingface.co/papers/2310.11511) ,在对话设置里面默认勾选。
 
213
  如需从源码启动服务,请参考以下步骤:
214
 
215
  1. 克隆仓库
216
+
217
  ```bash
218
  $ git clone https://github.com/infiniflow/ragflow.git
219
  $ cd ragflow/
220
  ```
221
 
222
  2. 创建虚拟环境(确保已安装 Anaconda 或 Miniconda)
223
+
224
  ```bash
225
  $ conda create -n ragflow python=3.11.0
226
  $ conda activate ragflow
227
  $ pip install -r requirements.txt
228
  ```
229
+ 如果 cuda > 12.0,需额外执行以下命令:
230
  ```bash
231
  $ pip uninstall -y onnxruntime-gpu
232
  $ pip install onnxruntime-gpu --extra-index-url https://aiinfra.pkgs.visualstudio.com/PublicPackages/_packaging/onnxruntime-cuda-12/pypi/simple/
233
  ```
234
 
235
  3. 拷贝入口脚本并配置环境变量
236
+
237
  ```bash
238
  $ cp docker/entrypoint.sh .
239
  $ vi entrypoint.sh
 
244
  $ pwd
245
  ```
246
 
247
+ 将上述 `which python` 的输出作为 `PY` 的值,将 `pwd` 的输出作为 `PYTHONPATH` 的值。
248
 
249
+ `LD_LIBRARY_PATH` 如果环境已经配置好,可以注释掉。
250
 
251
  ```bash
252
+ # 此处配置需要按照实际情况调整,两个 export 为新增配置
253
  PY=${PY}
254
  export PYTHONPATH=${PYTHONPATH}
255
+ # 可选:添加 Hugging Face 镜像
256
  export HF_ENDPOINT=https://hf-mirror.com
257
  ```
258
 
259
  4. 启动基础服务
260
+
261
  ```bash
262
  $ cd docker
263
  $ docker compose -f docker-compose-base.yml up -d
 
267
  确保**docker/.env**中的配置与**conf/service_conf.yaml**中配置一致, **service_conf.yaml**中相关服务的IP地址与端口应该改成本机IP地址及容器映射出来的端口。
268
 
269
  6. 启动服务
270
+
271
  ```bash
272
  $ chmod +x ./entrypoint.sh
273
  $ bash ./entrypoint.sh
274
  ```
275
+
276
  7. 启动WebUI服务
277
+
278
  ```bash
279
  $ cd web
280
  $ npm install --registry=https://registry.npmmirror.com --force
 
284
  ```
285
 
286
  8. 部署WebUI服务
287
+
288
  ```bash
289
  $ cd web
290
  $ npm install --registry=https://registry.npmmirror.com --force
 
316
 
317
  ## 🙌 贡献指南
318
 
319
+ RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们欢迎来自社区的各种贡献。如果您有意参与其中,请查阅我们的 [贡献者指南](./docs/references/CONTRIBUTING.md) 。
320
 
321
  ## 🤝 商务合作
322