Skip to content

Commit aaec630

Browse files
yuzhichangyuzhichang
authored
Obsoleted dev and dev-slim (#3930)
### What problem does this PR solve? Obsoleted dev and dev-slim ### Type of change - [x] Documentation Update
1 parent 3d735dc commit aaec630

File tree

15 files changed

+143
-126
lines changed

15 files changed

+143
-126
lines changed

‎.github/workflows/tests.yml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -55,28 +55,29 @@ jobs:
5555
with:
5656
version: ">=0.8.2"
5757

58-
- name: Build ragflow:dev-slim
58+
- name: Build ragflow:nightly-slim
5959
run: |
6060
RUNNER_WORKSPACE_PREFIX=${RUNNER_WORKSPACE_PREFIX:-$HOME}
6161
sudo docker pull ubuntu:22.04
62-
sudo docker build --progress=plain --build-arg LIGHTEN=1 --build-arg NEED_MIRROR=1 -f Dockerfile -t infiniflow/ragflow:dev-slim .
62+
sudo docker build --progress=plain --build-arg LIGHTEN=1 --build-arg NEED_MIRROR=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
6363
64-
- name: Build ragflow:dev
64+
- name: Build ragflow:nightly
6565
run: |
66-
sudo docker build --progress=plain --build-arg NEED_MIRROR=1 -f Dockerfile -t infiniflow/ragflow:dev .
66+
sudo docker build --progress=plain --build-arg NEED_MIRROR=1 -f Dockerfile -t infiniflow/ragflow:nightly .
6767
68-
- name: Start ragflow:dev-slim
68+
- name: Start ragflow:nightly-slim
6969
run: |
70+
echo "RAGFLOW_IMAGE=infiniflow/ragflow:nightly-slim" >> docker/.env
7071
sudo docker compose -f docker/docker-compose.yml up -d
7172
72-
- name: Stop ragflow:dev-slim
73+
- name: Stop ragflow:nightly-slim
7374
if: always() # always run this step even if previous steps failed
7475
run: |
7576
sudo docker compose -f docker/docker-compose.yml down -v
7677
77-
- name: Start ragflow:dev
78+
- name: Start ragflow:nightly
7879
run: |
79-
echo "RAGFLOW_IMAGE=infiniflow/ragflow:dev" >> docker/.env
80+
echo "RAGFLOW_IMAGE=infiniflow/ragflow:nightly" >> docker/.env
8081
sudo docker compose -f docker/docker-compose.yml up -d
8182
8283
- name: Run sdk tests against Elasticsearch
@@ -100,12 +101,12 @@ jobs:
100101
cd sdk/python && poetry install && source .venv/bin/activate && cd test/test_frontend_api && pytest -s --tb=short get_email.py test_dataset.py
101102
102103
103-
- name: Stop ragflow:dev
104+
- name: Stop ragflow:nightly
104105
if: always() # always run this step even if previous steps failed
105106
run: |
106107
sudo docker compose -f docker/docker-compose.yml down -v
107108
108-
- name: Start ragflow:dev
109+
- name: Start ragflow:nightly
109110
run: |
110111
sudo DOC_ENGINE=infinity docker compose -f docker/docker-compose.yml up -d
111112
@@ -129,7 +130,7 @@ jobs:
129130
done
130131
cd sdk/python && poetry install && source .venv/bin/activate && cd test/test_frontend_api && pytest -s --tb=short get_email.py test_dataset.py
131132
132-
- name: Stop ragflow:dev
133+
- name: Stop ragflow:nightly
133134
if: always() # always run this step even if previous steps failed
134135
run: |
135136
sudo DOC_ENGINE=infinity docker compose -f docker/docker-compose.yml down -v

‎README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -165,29 +165,25 @@ releases! 🌟
165165
$ git clone https://github.com/infiniflow/ragflow.git
166166
```
167167
168-
3. Build the pre-built Docker images and start up the server:
168+
3. Start up the server using the pre-built Docker images:
169169
170-
> The command below downloads the dev version Docker image for RAGFlow slim (`dev-slim`). Note that RAGFlow slim
171-
Docker images do not include embedding models or Python libraries and hence are approximately 1GB in size.
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.
172172
173173
```bash
174174
$ cd ragflow/docker
175175
$ docker compose -f docker-compose.yml up -d
176176
```
177177
178-
> - To download a RAGFlow slim Docker image of a specific version, update the `RAGFLOW_IMAGE` variable in *
179-
*docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1-slim`. After
180-
making this change, rerun the command above to initiate the download.
181-
> - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the
182-
`RAGFLOW_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change,
183-
rerun the command above to initiate the download.
184-
> - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update
185-
the `RAGFLOW_IMAGE` variable in **docker/.env** to your desired version. For example,
186-
`RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1`. After making this change, rerun the command above to initiate the
187-
download.
178+
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
179+
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
180+
| v0.14.1 | ~9 GB | YES | stable release |
181+
| v0.14.1-slim | ~2 GB | NO | stable release |
182+
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
183+
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
184+
| nightly | ~9 GB | YES | unstable nightly build |
185+
| nightly-slim | ~2 GB | NO | unstable nightly build |
188186
189-
> **NOTE:** A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size
190-
and may take significantly longer time to load.
191187
192188
4. Check the server status after having the server up and running:
193189
@@ -267,12 +263,12 @@ RAGFlow uses Elasticsearch by default for storing full text and vectors. To swit
267263
268264
## 🔧 Build a Docker image without embedding models
269265
270-
This image is approximately 1 GB in size and relies on external LLM and embedding services.
266+
This image is approximately 2 GB in size and relies on external LLM and embedding services.
271267
272268
```bash
273269
git clone https://github.com/infiniflow/ragflow.git
274270
cd ragflow/
275-
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:dev-slim .
271+
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
276272
```
277273
278274
## 🔧 Build a Docker image including embedding models
@@ -282,7 +278,7 @@ This image is approximately 9 GB in size. As it includes embedding models, it re
282278
```bash
283279
git clone https://github.com/infiniflow/ragflow.git
284280
cd ragflow/
285-
docker build -f Dockerfile -t infiniflow/ragflow:dev .
281+
docker build -f Dockerfile -t infiniflow/ragflow:nightly .
286282
```
287283
288284
## 🔨 Launch service from source for development

‎README_id.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -160,26 +160,24 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
160160
161161
3. Bangun image Docker pre-built dan jalankan server:
162162

163-
> Perintah di bawah ini akan mengunduh versi dev dari Docker image RAGFlow slim (`dev-slim`). Image RAGFlow slim
163+
> Perintah di bawah ini akan mengunduh versi v0.14.1 dari Docker image RAGFlow slim (`v0.14.1-slim`). Image RAGFlow slim
164164
tidak termasuk model embedding atau library Python dan berukuran sekitar 1GB.
165165

166166
```bash
167167
$ cd ragflow/docker
168168
$ docker compose -f docker-compose.yml up -d
169169
```
170170

171-
> - Untuk mengunduh versi tertentu dari image Docker RAGFlow slim, perbarui variabel `RAGFlow_IMAGE` di *
172-
*docker/.env** sesuai dengan versi yang diinginkan. Misalnya, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1-slim`.
173-
Setelah mengubah ini, jalankan ulang perintah di atas untuk memulai unduhan.
174-
> - Untuk mengunduh versi dev dari image Docker RAGFlow *termasuk* model embedding dan library Python, perbarui
175-
variabel `RAGFlow_IMAGE` di **docker/.env** menjadi `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. Setelah mengubah ini,
176-
jalankan ulang perintah di atas untuk memulai unduhan.
177-
> - Untuk mengunduh versi tertentu dari image Docker RAGFlow *termasuk* model embedding dan library Python, perbarui
178-
variabel `RAGFlow_IMAGE` di **docker/.env** sesuai dengan versi yang diinginkan. Misalnya,
179-
`RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1`. Setelah mengubah ini, jalankan ulang perintah di atas untuk memulai unduhan.
171+
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
172+
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
173+
| v0.14.1 | ~9 GB | YES | stable release |
174+
| v0.14.1-slim | ~2 GB | NO | stable release |
175+
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
176+
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
177+
| nightly | ~9 GB | YES | unstable nightly build |
178+
| nightly-slim | ~2 GB | NO | unstable nightly build |
179+
180180

181-
> **CATATAN:** Image Docker RAGFlow yang mencakup model embedding dan library Python berukuran sekitar 9GB
182-
dan mungkin memerlukan waktu lebih lama untuk dimuat.
183181

184182
4. Periksa status server setelah server aktif dan berjalan:
185183

@@ -242,12 +240,12 @@ Pembaruan konfigurasi ini memerlukan reboot semua kontainer agar efektif:
242240
243241
## 🔧 Membangun Docker Image tanpa Model Embedding
244242
245-
Image ini berukuran sekitar 1 GB dan bergantung pada aplikasi LLM eksternal dan embedding.
243+
Image ini berukuran sekitar 2 GB dan bergantung pada aplikasi LLM eksternal dan embedding.
246244
247245
```bash
248246
git clone https://github.com/infiniflow/ragflow.git
249247
cd ragflow/
250-
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:dev-slim .
248+
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
251249
```
252250
253251
## 🔧 Membangun Docker Image Termasuk Model Embedding
@@ -257,7 +255,7 @@ Image ini berukuran sekitar 9 GB. Karena sudah termasuk model embedding, ia hany
257255
```bash
258256
git clone https://github.com/infiniflow/ragflow.git
259257
cd ragflow/
260-
docker build -f Dockerfile -t infiniflow/ragflow:dev .
258+
docker build -f Dockerfile -t infiniflow/ragflow:nightly .
261259
```
262260

263261
## 🔨 Menjalankan Aplikasi dari untuk Pengembangan

‎README_ja.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -141,18 +141,22 @@
141141
142142
3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
143143

144-
> 以下のコマンドは、RAGFlow slim（`dev-slim`）の開発版Dockerイメージをダウンロードします。RAGFlow slimのDockerイメージには、埋め込みモデルやPythonライブラリが含まれていないため、サイズは約1GBです。
144+
> 以下のコマンドは、RAGFlow slim（`v0.14.1-slim`）の開発版Dockerイメージをダウンロードします。RAGFlow slimのDockerイメージには、埋め込みモデルやPythonライブラリが含まれていないため、サイズは約1GBです。
145145
146146
```bash
147147
$ cd ragflow/docker
148148
$ docker compose -f docker-compose.yml up -d
149149
```
150150

151-
> - 特定のバージョンのRAGFlow slim Dockerイメージをダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を希望のバージョンに更新します。例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1`とします。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
152-
> - RAGFlowの埋め込みモデルとPythonライブラリを含む開発版Dockerイメージをダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を`RAGFLOW_IMAGE=infiniflow/ragflow:dev`に更新します。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
153-
> - 特定のバージョンのRAGFlow Dockerイメージ（埋め込みモデルとPythonライブラリを含む）をダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を希望のバージョンに更新します。例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1`とします。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
154-
155-
> **NOTE:** 埋め込みモデルとPythonライブラリを含むRAGFlow Dockerイメージのサイズは約9GBであり、読み込みにかなりの時間がかかる場合があります。
151+
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
152+
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
153+
| v0.14.1 | ~9 GB | YES | stable release |
154+
| v0.14.1-slim | ~2 GB | NO | stable release |
155+
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
156+
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
157+
| nightly | ~9 GB | YES | unstable nightly build |
158+
| nightly-slim | ~2 GB | NO | unstable nightly build |
159+
156160

157161
4. サーバーを立ち上げた後、サーバーの状態を確認する:
158162

@@ -228,7 +232,7 @@ RAGFlow はデフォルトで Elasticsearch を使用して全文とベクトル
228232
```bash
229233
git clone https://github.com/infiniflow/ragflow.git
230234
cd ragflow/
231-
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:dev-slim .
235+
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
232236
```
233237

234238
## 🔧 ソースコードをコンパイルしたDockerイメージ（埋め込みモデルを含む）
@@ -238,7 +242,7 @@ docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:dev-slim
238242
```bash
239243
git clone https://github.com/infiniflow/ragflow.git
240244
cd ragflow/
241-
docker build -f Dockerfile -t infiniflow/ragflow:dev .
245+
docker build -f Dockerfile -t infiniflow/ragflow:nightly .
242246
```
243247

244248
## 🔨 ソースコードからサービスを起動する方法

‎README_ko.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -145,18 +145,24 @@
145145
146146
3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
147147

148-
> 아래의 명령은 RAGFlow slim(dev-slim)의 개발 버전 Docker 이미지를 다운로드합니다. RAGFlow slim Docker 이미지에는 임베딩 모델이나 Python 라이브러리가 포함되어 있지 않으므로 크기는 약 1GB입니다.
148+
> 아래의 명령은 RAGFlow slim(v0.14.1-slim)의 개발 버전 Docker 이미지를 다운로드합니다. RAGFlow slim Docker 이미지에는 임베딩 모델이나 Python 라이브러리가 포함되어 있지 않으므로 크기는 약 1GB입니다.
149149
150150
```bash
151151
$ cd ragflow/docker
152152
$ docker compose -f docker-compose.yml up -d
153153
```
154154

155-
> - 특정 버전의 RAGFlow slim Docker 이미지를 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 원하는 버전으로 업데이트하세요. 예를 들어, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1-slim`으로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
156-
> - RAGFlow의 임베딩 모델과 Python 라이브러리를 포함한 개발 버전 Docker 이미지를 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 `RAGFLOW_IMAGE=infiniflow/ragflow:dev`로 업데이트하세요. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
157-
> - 특정 버전의 RAGFlow Docker 이미지를 임베딩 모델과 Python 라이브러리를 포함하여 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 원하는 버전으로 업데이트하세요. 예를 들어, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1` 로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
158-
159-
> **NOTE:** 임베딩 모델과 Python 라이브러리를 포함한 RAGFlow Docker 이미지의 크기는 약 9GB이며, 로드하는 데 상당히 오랜 시간이 걸릴 수 있습니다.
155+
156+
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
157+
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
158+
| v0.14.1 | ~9 GB | YES | stable release |
159+
| v0.14.1-slim | ~2 GB | NO | stable release |
160+
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
161+
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
162+
| nightly | ~9 GB | YES | unstable nightly build |
163+
| nightly-slim | ~2 GB | NO | unstable nightly build |
164+
165+
160166

161167

162168
4. 서버가 시작된 후 서버 상태를 확인하세요:
@@ -230,7 +236,7 @@ RAGFlow 는 기본적으로 Elasticsearch 를 사용하여 전체 텍스트 및
230236
```bash
231237
git clone https://github.com/infiniflow/ragflow.git
232238
cd ragflow/
233-
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:dev-slim .
239+
docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
234240
```
235241

236242
## 🔧 소스 코드로 Docker 이미지를 컴파일합니다(임베딩 모델 포함)
@@ -240,7 +246,7 @@ docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:dev-slim
240246
```bash
241247
git clone https://github.com/infiniflow/ragflow.git
242248
cd ragflow/
243-
docker build -f Dockerfile -t infiniflow/ragflow:dev .
249+
docker build -f Dockerfile -t infiniflow/ragflow:nightly .
244250
```
245251

246252
## 🔨 소스 코드로 서비스를 시작합니다.

0 commit comments

Comments
 (0)