writinwaters commited on
Commit
01d7cd1
·
1 Parent(s): dfc220f

Updated RAGFlow edition descriptions (#4001)

Browse files

### What problem does this PR solve?


### Type of change

- [x] Documentation Update

Files changed (6) hide show
  1. README.md +1 -2
  2. README_id.md +1 -2
  3. README_ja.md +1 -1
  4. README_ko.md +1 -1
  5. README_zh.md +1 -1
  6. docs/quickstart.mdx +11 -13
README.md CHANGED
@@ -167,8 +167,7 @@ releases! 🌟
167
 
168
  3. Start up the server using the pre-built Docker images:
169
 
170
- > The command below downloads the v0.14.1 version Docker image for RAGFlow slim (`v0.14.1-slim`). Note that RAGFlow slim
171
- Docker images do not include embedding models or Python libraries and hence are approximately 2 GB in size.
172
 
173
  ```bash
174
  $ cd ragflow
 
167
 
168
  3. Start up the server using the pre-built Docker images:
169
 
170
+ > The command below downloads the `v0.14.1-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download an RAGFlow edition different from `v0.14.1-slim`, update the `RAGFLOW_IMAGE` variable accordingly in **docker/.env** before using `docker compose` to start the server. For example: set `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1` for the full edition `v0.14.1`.
 
171
 
172
  ```bash
173
  $ cd ragflow
README_id.md CHANGED
@@ -160,8 +160,7 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
160
 
161
  3. Bangun image Docker pre-built dan jalankan server:
162
 
163
- > Perintah di bawah ini akan mengunduh versi v0.14.1 dari Docker image RAGFlow slim (`v0.14.1-slim`). Image RAGFlow slim
164
- tidak termasuk model embedding atau library Python dan berukuran sekitar 1GB.
165
 
166
  ```bash
167
  $ cd ragflow
 
160
 
161
  3. Bangun image Docker pre-built dan jalankan server:
162
 
163
+ > Perintah di bawah ini mengunduh edisi v0.14.1-slim dari gambar Docker RAGFlow. Silakan merujuk ke tabel berikut untuk deskripsi berbagai edisi RAGFlow. Untuk mengunduh edisi RAGFlow yang berbeda dari v0.14.1-slim, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. Misalnya, atur RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1 untuk edisi lengkap v0.14.1.
 
164
 
165
  ```bash
166
  $ cd ragflow
README_ja.md CHANGED
@@ -141,7 +141,7 @@
141
 
142
  3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
143
 
144
- > 以下のコマンドは、RAGFlow slim(`v0.14.1-slim`)の開発版Dockerイメージをダウンロードします。RAGFlow slimのDockerイメージには、埋め込みモデルやPythonライブラリが含まれていないため、サイズは約1GBです。
145
 
146
  ```bash
147
  $ cd ragflow
 
141
 
142
  3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
143
 
144
+ > 以下のコマンドは、RAGFlow Dockerイメージの v0.14.1-slim エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.14.1-slim とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。例えば、完全版 v0.14.1 をダウンロードするには、RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1 と設定します。
145
 
146
  ```bash
147
  $ cd ragflow
README_ko.md CHANGED
@@ -145,7 +145,7 @@
145
 
146
  3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
147
 
148
- > 아래의 명령은 RAGFlow slim(v0.14.1-slim)의 개발 버전 Docker 이미지를 다운로드합니다. RAGFlow slim Docker 이미지에는 임베딩 모델이나 Python 라이브러리가 포함되어 있지 않으므로 크기는 1GB입니다.
149
 
150
  ```bash
151
  $ cd ragflow
 
145
 
146
  3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
147
 
148
+ > 아래 명령어는 RAGFlow Docker 이미지의 v0.14.1-slim 버전을 다운로드합니다. 다양한 RAGFlow 버전에 대한 설명은 다음 표를 참조하십시오. v0.14.1-slim 다른 RAGFlow 버전을 다운로드하려면, docker/.env 파일에서 RAGFLOW_IMAGE 변수를 적절히 업데이트한 docker compose를 사용하여 서버를 시작하십시오. 예를 들어, 전체 버전인 v0.14.1을 다운로드하려면 RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1로 설정합니다.
149
 
150
  ```bash
151
  $ cd ragflow
README_zh.md CHANGED
@@ -142,7 +142,7 @@
142
 
143
  3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器:
144
 
145
- > 运行以下命令会自动下载 v0.14.1 版的 RAGFlow slim Docker 镜像(`v0.14.1-slim`),该镜像并不包含 embedding 模型以及一些 Python 库,因此镜像大小约 1GB。
146
 
147
  ```bash
148
  $ cd ragflow
 
142
 
143
  3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器:
144
 
145
+ > 运行以下命令会自动下载 RAGFlow slim Docker 镜像 `v0.14.1-slim`。请参考下表查看不同 Docker 发行版的描述。如需下载不同于 `v0.14.0-slim` Docker 镜像,请在运行 `docker compose` 启动服务之前先更新 **docker/.env** 文件内的 `RAGFLOW_IMAGE` 变量。比如,你可以通过设置 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1` 来下载 RAGFlow 镜像的 `v0.14.1` 完整发行版。
146
 
147
  ```bash
148
  $ cd ragflow
docs/quickstart.mdx CHANGED
@@ -184,7 +184,9 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
184
 
185
  3. Use the pre-built Docker images and start up the server:
186
 
187
- > The command below downloads the v0.14.1 version Docker image for RAGFlow slim (`v0.14.1-slim`). Note that RAGFlow slim Docker images do not include embedding models or Python libraries and hence are approximately 2 GB in size.
 
 
188
 
189
  ```bash
190
  $ docker compose -f docker/docker-compose.yml up -d
@@ -194,23 +196,19 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
194
  <APITable>
195
  ```
196
 
197
- | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
198
- | ----------------- | --------------- | --------------------- | ------------------------ |
199
- | v0.14.1 | &approx;9 | :heavy_check_mark: | Stable release |
200
- | v0.14.1-slim | &approx;2 | ❌ | Stable release |
201
- | v0.15.0-dev1 | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
202
- | v0.15.0-dev1-slim | &approx;2 | ❌ | *Unstable* beta release |
203
- | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
204
- | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
205
 
206
  ```mdx-code-block
207
  </APITable>
208
  ```
209
 
210
- :::tip NOTE
211
- A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load.
212
- :::
213
-
214
  4. Check the server status after having the server up and running:
215
 
216
  ```bash
 
184
 
185
  3. Use the pre-built Docker images and start up the server:
186
 
187
+ :::tip NOTE
188
+ The command below downloads the `v0.14.1-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download an RAGFlow edition different from `v0.14.1-slim`, update the `RAGFLOW_IMAGE` variable accordingly in **docker/.env** before using `docker compose` to start the server. For example: set `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1` for the full edition `v0.14.1`.
189
+ :::
190
 
191
  ```bash
192
  $ docker compose -f docker/docker-compose.yml up -d
 
196
  <APITable>
197
  ```
198
 
199
+ | RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? |
200
+ | ------------------- | --------------- | ----------------------------------------- | ------------------------ |
201
+ | `v0.14.1` | &approx;9 | :heavy_check_mark: | Stable release |
202
+ | `v0.14.1-slim` | &approx;2 | ❌ | Stable release |
203
+ | `v0.15.0-dev1` | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
204
+ | `v0.15.0-dev1-slim` | &approx;2 | ❌ | *Unstable* beta release |
205
+ | `nightly` | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
206
+ | `nightly-slim` | &approx;2 | ❌ | *Unstable* nightly build |
207
 
208
  ```mdx-code-block
209
  </APITable>
210
  ```
211
 
 
 
 
 
212
  4. Check the server status after having the server up and running:
213
 
214
  ```bash