Skip to content

Commit

Permalink
Updated RAGFlow edition descriptions (infiniflow#4001)
Browse files Browse the repository at this point in the history
### What problem does this PR solve?


### Type of change

- [x] Documentation Update
  • Loading branch information
writinwaters authored and isthaison committed Dec 13, 2024
1 parent 0382691 commit 28b157c
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 20 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,7 @@ releases! 🌟
3. Start up the server using the pre-built Docker images:
> 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.
> 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`.
```bash
$ cd ragflow
Expand Down
3 changes: 1 addition & 2 deletions README_id.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,7 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
3. Bangun image Docker pre-built dan jalankan server:

> Perintah di bawah ini akan mengunduh versi v0.14.1 dari Docker image RAGFlow slim (`v0.14.1-slim`). Image RAGFlow slim
tidak termasuk model embedding atau library Python dan berukuran sekitar 1GB.
> 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.
```bash
$ cd ragflow
Expand Down
2 changes: 1 addition & 1 deletion README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@
3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:

> 以下のコマンドは、RAGFlow slim(`v0.14.1-slim`)の開発版Dockerイメージをダウンロードします。RAGFlow slimのDockerイメージには、埋め込みモデルやPythonライブラリが含まれていないため、サイズは約1GBです
> 以下のコマンドは、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 と設定します
```bash
$ cd ragflow
Expand Down
2 changes: 1 addition & 1 deletion README_ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@
3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:

> 아래의 명령은 RAGFlow slim(v0.14.1-slim)의 개발 버전 Docker 이미지를 다운로드합니다. RAGFlow slim Docker 이미지에는 임베딩 모델이나 Python 라이브러리가 포함되어 있지 않으므로 크기는 약 1GB입니다.
> 아래 명령어는 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로 설정합니다.
```bash
$ cd ragflow
Expand Down
2 changes: 1 addition & 1 deletion README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器:

> 运行以下命令会自动下载 v0.14.1 版的 RAGFlow slim Docker 镜像`v0.14.1-slim`),该镜像并不包含 embedding 模型以及一些 Python 库,因此镜像大小约 1GB
> 运行以下命令会自动下载 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` 完整发行版
```bash
$ cd ragflow
Expand Down
24 changes: 11 additions & 13 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,9 @@ This section provides instructions on setting up the RAGFlow server on Linux. If

3. Use the pre-built Docker images and start up the server:

> 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.
:::tip NOTE
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`.
:::

```bash
$ docker compose -f docker/docker-compose.yml up -d
Expand All @@ -194,23 +196,19 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
<APITable>
```

| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | &approx;9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | &approx;2 || Stable release |
| v0.15.0-dev1 | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | &approx;2 || *Unstable* beta release |
| nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | &approx;2 || *Unstable* nightly build |
| RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? |
| ------------------- | --------------- | ----------------------------------------- | ------------------------ |
| `v0.14.1` | &approx;9 | :heavy_check_mark: | Stable release |
| `v0.14.1-slim` | &approx;2 | | Stable release |
| `v0.15.0-dev1` | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
| `v0.15.0-dev1-slim` | &approx;2 | | *Unstable* beta release |
| `nightly` | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
| `nightly-slim` | &approx;2 | | *Unstable* nightly build |

```mdx-code-block
</APITable>
```

:::tip NOTE
A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load.
:::

4. Check the server status after having the server up and running:

```bash
Expand Down

0 comments on commit 28b157c

Please sign in to comment.