AI/ragflow
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git synced 2025-08-12 20:59:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
### 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):
This commit is contained in:
植心 2024-08-20 18:49:11 +08:00 committed by GitHub
parent be431449bd
commit 7927d80a84
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README_ja.md
View File

@ -236,21 +236,21 @@ $ pip install onnxruntime-gpu --extra-index-url https://aiinfra.pkgs.visualstudi
$ cp docker/entrypoint.sh . $ cp docker/entrypoint.sh .
$ vi entrypoint.sh $ vi entrypoint.sh
``` ```
以下のコマンドでPythonのパスとragflowプロジェクトのパスを取得します： 以下のコマンドで Python のパスとragflowプロジェクトのパスを取得します：
```bash ```bash
$ which python $ which python
$ pwd $ pwd
``` ```
`which python`の出力を`PY`の値として、`pwd`の出力を`PYTHONPATH`の値として設定します。 `which python` の出力を `PY` の値として、`pwd` の出力を `PYTHONPATH` の値として設定します。
`LD_LIBRARY_PATH`が既に設定されている場合は、コメントアウトできます。 `LD_LIBRARY_PATH` が既に設定されている場合は、コメントアウトできます。
```bash ```bash
# 実際の状況に応じて設定を調整してください。以下の二つのexportは新たに追加された設定です # 実際の状況に応じて設定を調整してください。以下の二つの export は新たに追加された設定です
PY=${PY} PY=${PY}
export PYTHONPATH=${PYTHONPATH} export PYTHONPATH=${PYTHONPATH}
# オプション：Hugging Faceミラーを追加 # オプション：Hugging Face ミラーを追加
export HF_ENDPOINT=https://hf-mirror.com export HF_ENDPOINT=https://hf-mirror.com
``` ```
@ -261,7 +261,7 @@ $ docker compose -f docker-compose-base.yml up -d
``` ```
5. 設定ファイルを確認します 5. 設定ファイルを確認します
**docker/.env**内の設定が**conf/service_conf.yaml**内の設定と一致していることを確認してください。**service_conf.yaml**内の関連サービスのIPアドレスとポートは、ローカルマシンのIPアドレスとコンテナが公開するポートに変更する必要があります。 **docker/.env** 内の設定が**conf/service_conf.yaml**内の設定と一致していることを確認してください。**service_conf.yaml**内の関連サービスのIPアドレスとポートは、ローカルマシンのIPアドレスとコンテナが公開するポートに変更する必要があります。
6. サービスを起動します 6. サービスを起動します
```bash ```bash
@ -288,4 +288,4 @@ $ bash ./entrypoint.sh
## 🙌 コントリビュート ## 🙌 コントリビュート
RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず[コントリビューションガイド](./docs/references/CONTRIBUTING.md)をご覧ください。 RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。 参加を希望される方は、まず [コントリビューションガイド](./docs/references/CONTRIBUTING.md)をご覧ください。

20
README_zh.md
View File

@ -213,24 +213,27 @@ $ docker compose up -d
如需从源码启动服务，请参考以下步骤： 如需从源码启动服务，请参考以下步骤：
1. 克隆仓库 1. 克隆仓库
```bash ```bash
$ git clone https://github.com/infiniflow/ragflow.git $ git clone https://github.com/infiniflow/ragflow.git
$ cd ragflow/ $ cd ragflow/
``` ```
2. 创建虚拟环境（确保已安装 Anaconda 或 Miniconda） 2. 创建虚拟环境（确保已安装 Anaconda 或 Miniconda）
```bash ```bash
$ conda create -n ragflow python=3.11.0 $ conda create -n ragflow python=3.11.0
$ conda activate ragflow $ conda activate ragflow
$ pip install -r requirements.txt $ pip install -r requirements.txt
``` ```
如果cuda > 12.0，需额外执行以下命令： 如果 cuda > 12.0，需额外执行以下命令：
```bash ```bash
$ pip uninstall -y onnxruntime-gpu $ pip uninstall -y onnxruntime-gpu
$ pip install onnxruntime-gpu --extra-index-url https://aiinfra.pkgs.visualstudio.com/PublicPackages/_packaging/onnxruntime-cuda-12/pypi/simple/ $ pip install onnxruntime-gpu --extra-index-url https://aiinfra.pkgs.visualstudio.com/PublicPackages/_packaging/onnxruntime-cuda-12/pypi/simple/
``` ```
3. 拷贝入口脚本并配置环境变量 3. 拷贝入口脚本并配置环境变量
```bash ```bash
$ cp docker/entrypoint.sh . $ cp docker/entrypoint.sh .
$ vi entrypoint.sh $ vi entrypoint.sh
@ -241,19 +244,20 @@ $ which python
$ pwd $ pwd
``` ```
将上述`which python`的输出作为`PY`的值，将`pwd`的输出作为`PYTHONPATH`的值。 将上述 `which python` 的输出作为 `PY` 的值，将 `pwd` 的输出作为 `PYTHONPATH` 的值。
`LD_LIBRARY_PATH`如果环境已经配置好，可以注释掉。 `LD_LIBRARY_PATH` 如果环境已经配置好，可以注释掉。
```bash ```bash
# 此处配置需要按照实际情况调整，两个export为新增配置 # 此处配置需要按照实际情况调整，两个 export 为新增配置
PY=${PY} PY=${PY}
export PYTHONPATH=${PYTHONPATH} export PYTHONPATH=${PYTHONPATH}
# 可选：添加Hugging Face镜像 # 可选：添加 Hugging Face 镜像
export HF_ENDPOINT=https://hf-mirror.com export HF_ENDPOINT=https://hf-mirror.com
``` ```
4. 启动基础服务 4. 启动基础服务
```bash ```bash
$ cd docker $ cd docker
$ docker compose -f docker-compose-base.yml up -d $ docker compose -f docker-compose-base.yml up -d
@ -263,11 +267,14 @@ $ docker compose -f docker-compose-base.yml up -d
确保**docker/.env**中的配置与**conf/service_conf.yaml**中配置一致， **service_conf.yaml**中相关服务的IP地址与端口应该改成本机IP地址及容器映射出来的端口。 确保**docker/.env**中的配置与**conf/service_conf.yaml**中配置一致， **service_conf.yaml**中相关服务的IP地址与端口应该改成本机IP地址及容器映射出来的端口。
6. 启动服务 6. 启动服务
```bash ```bash
$ chmod +x ./entrypoint.sh $ chmod +x ./entrypoint.sh
$ bash ./entrypoint.sh $ bash ./entrypoint.sh
``` ```
7. 启动WebUI服务 7. 启动WebUI服务
```bash ```bash
$ cd web $ cd web
$ npm install --registry=https://registry.npmmirror.com --force $ npm install --registry=https://registry.npmmirror.com --force
@ -277,6 +284,7 @@ $ npm run dev
``` ```
8. 部署WebUI服务 8. 部署WebUI服务
```bash ```bash
$ cd web $ cd web
$ npm install --registry=https://registry.npmmirror.com --force $ npm install --registry=https://registry.npmmirror.com --force
@ -308,7 +316,7 @@ $ systemctl start nginx
## 🙌 贡献指南 ## 🙌 贡献指南
RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们欢迎来自社区的各种贡献。如果您有意参与其中,请查阅我们的[贡献者指南](./docs/references/CONTRIBUTING.md) 。 RAGFlow 只有通过开源协作才能蓬勃发展。秉持这一精神,我们欢迎来自社区的各种贡献。如果您有意参与其中,请查阅我们的 [贡献者指南](./docs/references/CONTRIBUTING.md) 。
## 🤝 商务合作 ## 🤝 商务合作