From 1db4d275816ab4d73ce61ffdb3f3436b76ab2cf0 Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Sun, 29 Sep 2024 15:31:12 +0800 Subject: [PATCH 1/8] Update README Signed-off-by: Jin Hai --- README.md | 76 ++++++++++++++++++++++++++++++++ docker/launch_backend_service.sh | 28 ++++++++++++ 2 files changed, 104 insertions(+) create mode 100644 docker/launch_backend_service.sh diff --git a/README.md b/README.md index 45628b2234..d6367167b1 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ - ๐Ÿ”Ž [System Architecture](#-system-architecture) - ๐ŸŽฌ [Get Started](#-get-started) - ๐Ÿ”ง [Configurations](#-configurations) +- ๐Ÿ”ง [Build RAGFlow image](#-build-ragflow-image) +- ๐Ÿ”ง [Launch service from source for development](#-launch-service-from-source-for-development) - ๐Ÿ“š [Documentation](#-documentation) - ๐Ÿ“œ [Roadmap](#-roadmap) - ๐Ÿ„ [Community](#-community) @@ -208,6 +210,80 @@ Updates to the above configurations require a reboot of all containers to take e > $ docker-compose -f docker/docker-compose.yml up -d > ``` +## ๐Ÿ› ๏ธ Build light RAGFlow image + +This image is approximately 1 GB in size and relies on external LLM services, as it does not include document parsing and embedding models. + +```bash +git clone https://github.com/infiniflow/ragflow.git +cd ragflow/ +docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . +``` + +### Build docker image + +This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes document parsing, and embedding models. + +```bash +pip3 install huggingface-hub +python3 download_deps.py # Download document parsing and embedding models +docker build -f Dockerfile -t infiniflow/ragflow:dev . +``` + +## ๐Ÿ› ๏ธ Launch service from source for development + +1. Install Poetry, if you already installed Poetry, please skip this step: + ```bash + curl -sSL https://install.python-poetry.org | python3 - + ``` + +2. Get RAGFlow source code and install Python dependencies: + ```bash + git clone https://github.com/infiniflow/ragflow.git + cd ragflow/ + export POETRY_VIRTUALENVS_CREATE=true POETRY_VIRTUALENVS_IN_PROJECT=true + ~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules + ``` + +3. Launch the RAGFlow dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose: + ```bash + docker compose -f docker/docker-compose-base.yml up -d + ``` + + Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/service_conf.yaml** to `127.0.0.1`: + ``` + 127.0.0.1 es01 mysql minio redis + ``` + In **docker/service_conf.yaml**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**. + +4. If you cannot access HuggingFace, set the HF_ENDPOINT environment variable to use a mirror site: + + ```bash + export HF_ENDPOINT=https://hf-mirror.com + ``` + +5. Launch RAGFlow backend service: + ```bash + source .venv/bin/activate + export PYTHONPATH=$(pwd) + bash docker/launch_backend_service.sh + ``` + +6. Install frontend dependencies: + ```bash + cd web + npm install --force + ``` +7. Configure frontend to update `proxy.target` in **.umirc.ts** to `http://127.0.0.1:9380`: +8. Launch RAGFlow frontend service: + ```bash + npm run dev + ``` + + _The following output confirms a successful launch of the system:_ + + ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187) + ## ๐Ÿ“š Documentation - [Quickstart](https://ragflow.io/docs/dev/) diff --git a/docker/launch_backend_service.sh b/docker/launch_backend_service.sh new file mode 100644 index 0000000000..a3e374cde2 --- /dev/null +++ b/docker/launch_backend_service.sh @@ -0,0 +1,28 @@ +#!/bin/bash + +# unset http proxy which maybe set by docker daemon +export http_proxy=""; export https_proxy=""; export no_proxy=""; export HTTP_PROXY=""; export HTTPS_PROXY=""; export NO_PROXY="" + +export LD_LIBRARY_PATH=/usr/lib/x86_64-linux-gnu/ + +PY=python3 +if [[ -z "$WS" || $WS -lt 1 ]]; then + WS=1 +fi + +function task_exe(){ + while [ 1 -eq 1 ];do + $PY rag/svr/task_executor.py $1; + done +} + +for ((i=0;i Date: Sun, 29 Sep 2024 15:36:50 +0800 Subject: [PATCH 2/8] Fix error link Signed-off-by: Jin Hai --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d6367167b1..e46ec56afe 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,8 @@ - ๐Ÿ”Ž [System Architecture](#-system-architecture) - ๐ŸŽฌ [Get Started](#-get-started) - ๐Ÿ”ง [Configurations](#-configurations) -- ๐Ÿ”ง [Build RAGFlow image](#-build-ragflow-image) +- ๐Ÿ”ง [Build light docker image](#-build-light-docker-image) +- ๐Ÿ”ง [Build docker image](#-build-docker-image) - ๐Ÿ”ง [Launch service from source for development](#-launch-service-from-source-for-development) - ๐Ÿ“š [Documentation](#-documentation) - ๐Ÿ“œ [Roadmap](#-roadmap) @@ -210,7 +211,7 @@ Updates to the above configurations require a reboot of all containers to take e > $ docker-compose -f docker/docker-compose.yml up -d > ``` -## ๐Ÿ› ๏ธ Build light RAGFlow image +## ๐Ÿ”ง Build light docker image This image is approximately 1 GB in size and relies on external LLM services, as it does not include document parsing and embedding models. @@ -220,7 +221,7 @@ cd ragflow/ docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ``` -### Build docker image +### ๐Ÿ”ง Build docker image This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes document parsing, and embedding models. @@ -230,7 +231,7 @@ python3 download_deps.py # Download document parsing and embedding models docker build -f Dockerfile -t infiniflow/ragflow:dev . ``` -## ๐Ÿ› ๏ธ Launch service from source for development +## ๐Ÿ”ง Launch service from source for development 1. Install Poetry, if you already installed Poetry, please skip this step: ```bash From b6b8646abf83660fe126527a479040c29617c7dc Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Sun, 29 Sep 2024 15:46:28 +0800 Subject: [PATCH 3/8] Fix docs Signed-off-by: Jin Hai --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e46ec56afe..fa17409207 100644 --- a/README.md +++ b/README.md @@ -211,9 +211,9 @@ Updates to the above configurations require a reboot of all containers to take e > $ docker-compose -f docker/docker-compose.yml up -d > ``` -## ๐Ÿ”ง Build light docker image +## ๐Ÿ”ง Build docker image without embedding model -This image is approximately 1 GB in size and relies on external LLM services, as it does not include document parsing and embedding models. +This image is approximately 1 GB in size and relies on external LLM and embedding services, as it only includes document parsing models. ```bash git clone https://github.com/infiniflow/ragflow.git @@ -221,7 +221,7 @@ cd ragflow/ docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ``` -### ๐Ÿ”ง Build docker image +### ๐Ÿ”ง Build docker image with embedding model This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes document parsing, and embedding models. From 2c9ed27f04e346a46cfdfbc89663b5d614645739 Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Sun, 29 Sep 2024 15:51:28 +0800 Subject: [PATCH 4/8] Fix errors Signed-off-by: Jin Hai --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fa17409207..61ecf88a60 100644 --- a/README.md +++ b/README.md @@ -42,9 +42,9 @@ - ๐Ÿ”Ž [System Architecture](#-system-architecture) - ๐ŸŽฌ [Get Started](#-get-started) - ๐Ÿ”ง [Configurations](#-configurations) -- ๐Ÿ”ง [Build light docker image](#-build-light-docker-image) -- ๐Ÿ”ง [Build docker image](#-build-docker-image) -- ๐Ÿ”ง [Launch service from source for development](#-launch-service-from-source-for-development) +- ๐Ÿช› [Build docker image without embedding model](#-build-docker-image-without-embedding-model) +- ๐Ÿชš [Build docker image with embedding model](#-build-docker-image-with-embedding-model) +- ๐Ÿ”จ [Launch service from source for development](#-launch-service-from-source-for-development) - ๐Ÿ“š [Documentation](#-documentation) - ๐Ÿ“œ [Roadmap](#-roadmap) - ๐Ÿ„ [Community](#-community) @@ -211,27 +211,31 @@ Updates to the above configurations require a reboot of all containers to take e > $ docker-compose -f docker/docker-compose.yml up -d > ``` -## ๐Ÿ”ง Build docker image without embedding model +## ๐Ÿช› Build docker image without embedding model This image is approximately 1 GB in size and relies on external LLM and embedding services, as it only includes document parsing models. ```bash git clone https://github.com/infiniflow/ragflow.git cd ragflow/ +pip3 install huggingface-hub +python3 download_deps.py # embedding models docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ``` -### ๐Ÿ”ง Build docker image with embedding model +## ๐Ÿชš Build docker image with embedding model This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes document parsing, and embedding models. ```bash +git clone https://github.com/infiniflow/ragflow.git +cd ragflow/ pip3 install huggingface-hub -python3 download_deps.py # Download document parsing and embedding models +python3 download_deps.py # embedding models docker build -f Dockerfile -t infiniflow/ragflow:dev . ``` -## ๐Ÿ”ง Launch service from source for development +## ๐Ÿ”จ Launch service from source for development 1. Install Poetry, if you already installed Poetry, please skip this step: ```bash From 514fc94940fc2a170948351281f463ad7f8b2c4b Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Sun, 29 Sep 2024 16:06:03 +0800 Subject: [PATCH 5/8] Update welcome logo Signed-off-by: Jin Hai --- README.md | 12 ++++++------ README_ja.md | 11 +++++------ README_ko.md | 11 +++++------ README_zh.md | 11 +++++------ api/ragflow_server.py | 11 +++++------ docs/quickstart.mdx | 11 +++++------ docs/references/faq.md | 11 +++++------ 7 files changed, 36 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 61ecf88a60..b86ea2e820 100644 --- a/README.md +++ b/README.md @@ -169,12 +169,12 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). _The following output confirms a successful launch of the system:_ ```bash - ____ ______ __ - / __ \ ____ _ ____ _ / ____// /____ _ __ - / /_/ // __ `// __ `// /_ / // __ \| | /| / / - / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ / - /_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/ - /____/ + ____ ___ ______ ______ __ + / __ \ / | / ____// ____// /____ _ __ + / /_/ // /| | / / __ / /_ / // __ \| | /| / / + / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / + /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ + * Running on all addresses (0.0.0.0) * Running on http://127.0.0.1:9380 diff --git a/README_ja.md b/README_ja.md index 2f931f82af..0c033529e6 100644 --- a/README_ja.md +++ b/README_ja.md @@ -152,12 +152,11 @@ _ไปฅไธ‹ใฎๅ‡บๅŠ›ใฏใ€ใ‚ทใ‚นใƒ†ใƒ ใŒๆญฃๅธธใซ่ตทๅ‹•ใ—ใŸใ“ใจใ‚’็ขบ่ชใ™ใ‚‹ใ‚‚ใฎใงใ™:_ ```bash - ____ ______ __ - / __ \ ____ _ ____ _ / ____// /____ _ __ - / /_/ // __ `// __ `// /_ / // __ \| | /| / / - / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ / - /_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/ - /____/ + ____ ___ ______ ______ __ + / __ \ / | / ____// ____// /____ _ __ + / /_/ // /| | / / __ / /_ / // __ \| | /| / / + / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / + /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ * Running on all addresses (0.0.0.0) * Running on http://127.0.0.1:9380 diff --git a/README_ko.md b/README_ko.md index 077cbe33c9..5f05ac1cb8 100644 --- a/README_ko.md +++ b/README_ko.md @@ -157,12 +157,11 @@ _๋‹ค์Œ ์ถœ๋ ฅ ๊ฒฐ๊ณผ๋กœ ์‹œ์Šคํ…œ์ด ์„ฑ๊ณต์ ์œผ๋กœ ์‹œ์ž‘๋˜์—ˆ์Œ์„ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค:_ ```bash - ____ ______ __ - / __ \ ____ _ ____ _ / ____// /____ _ __ - / /_/ // __ `// __ `// /_ / // __ \| | /| / / - / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ / - /_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/ - /____/ + ____ ___ ______ ______ __ + / __ \ / | / ____// ____// /____ _ __ + / /_/ // /| | / / __ / /_ / // __ \| | /| / / + / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / + /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ * Running on all addresses (0.0.0.0) * Running on http://127.0.0.1:9380 diff --git a/README_zh.md b/README_zh.md index 5a6fe3209c..3e62d8c6cc 100644 --- a/README_zh.md +++ b/README_zh.md @@ -150,12 +150,11 @@ _ๅ‡บ็Žฐไปฅไธ‹็•Œ้ขๆ็คบ่ฏดๆ˜ŽๆœๅŠกๅ™จๅฏๅŠจๆˆๅŠŸ๏ผš_ ```bash - ____ ______ __ - / __ \ ____ _ ____ _ / ____// /____ _ __ - / /_/ // __ `// __ `// /_ / // __ \| | /| / / - / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ / - /_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/ - /____/ + ____ ___ ______ ______ __ + / __ \ / | / ____// ____// /____ _ __ + / /_/ // /| | / / __ / /_ / // __ \| | /| / / + / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / + /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ * Running on all addresses (0.0.0.0) * Running on http://127.0.0.1:9380 diff --git a/api/ragflow_server.py b/api/ragflow_server.py index e5d450c37b..9fabb05ba3 100644 --- a/api/ragflow_server.py +++ b/api/ragflow_server.py @@ -47,12 +47,11 @@ def update_progress(): if __name__ == '__main__': print(r""" - ____ ______ __ - / __ \ ____ _ ____ _ / ____// /____ _ __ - / /_/ // __ `// __ `// /_ / // __ \| | /| / / - / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ / -/_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/ - /____/ + ____ ___ ______ ______ __ + / __ \ / | / ____// ____// /____ _ __ + / /_/ // /| | / / __ / /_ / // __ \| | /| / / + / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / + /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ """, flush=True) stat_logger.info( diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 6ab4e6a487..c237dd3fc9 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -196,12 +196,11 @@ This section provides instructions on setting up the RAGFlow server on Linux. If _The following output confirms a successful launch of the system:_ ```bash - ____ ______ __ - / __ \ ____ _ ____ _ / ____// /____ _ __ - / /_/ // __ `// __ `// /_ / // __ \| | /| / / - / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ / - /_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/ - /____/ + ____ ___ ______ ______ __ + / __ \ / | / ____// ____// /____ _ __ + / /_/ // /| | / / __ / /_ / // __ \| | /| / / + / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / + /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ * Running on all addresses (0.0.0.0) * Running on http://127.0.0.1:9380 diff --git a/docs/references/faq.md b/docs/references/faq.md index d3b8b4649f..8afe45af36 100644 --- a/docs/references/faq.md +++ b/docs/references/faq.md @@ -168,12 +168,11 @@ You will not log in to RAGFlow unless the server is fully initialized. Run `dock *The server is successfully initialized, if your system displays the following:* ``` - ____ ______ __ - / __ \ ____ _ ____ _ / ____// /____ _ __ - / /_/ // __ `// __ `// /_ / // __ \| | /| / / - / _, _// /_/ // /_/ // __/ / // /_/ /| |/ |/ / -/_/ |_| \__,_/ \__, //_/ /_/ \____/ |__/|__/ - /____/ + ____ ___ ______ ______ __ + / __ \ / | / ____// ____// /____ _ __ + / /_/ // /| | / / __ / /_ / // __ \| | /| / / + / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ / + /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/ * Running on all addresses (0.0.0.0) * Running on http://127.0.0.1:9380 From d6b4fdd4c09e6af97cba63c025ddbe1ae41c007e Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Sun, 29 Sep 2024 16:18:16 +0800 Subject: [PATCH 6/8] Fix format Signed-off-by: Jin Hai --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b86ea2e820..f4acee0b9f 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,8 @@ - ๐Ÿ”Ž [System Architecture](#-system-architecture) - ๐ŸŽฌ [Get Started](#-get-started) - ๐Ÿ”ง [Configurations](#-configurations) -- ๐Ÿช› [Build docker image without embedding model](#-build-docker-image-without-embedding-model) -- ๐Ÿชš [Build docker image with embedding model](#-build-docker-image-with-embedding-model) +- ๐Ÿช› [Build docker image without embedding models](#-build-docker-image-without-embedding-models) +- ๐Ÿชš [Build docker image with embedding models](#-build-docker-image-with-embedding-models) - ๐Ÿ”จ [Launch service from source for development](#-launch-service-from-source-for-development) - ๐Ÿ“š [Documentation](#-documentation) - ๐Ÿ“œ [Roadmap](#-roadmap) @@ -211,7 +211,7 @@ Updates to the above configurations require a reboot of all containers to take e > $ docker-compose -f docker/docker-compose.yml up -d > ``` -## ๐Ÿช› Build docker image without embedding model +## ๐Ÿช› Build docker image without embedding models This image is approximately 1 GB in size and relies on external LLM and embedding services, as it only includes document parsing models. @@ -223,9 +223,9 @@ python3 download_deps.py # embedding models docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ``` -## ๐Ÿชš Build docker image with embedding model +## ๐Ÿชš Build docker image with embedding models -This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes document parsing, and embedding models. +This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes document parsing and embedding models. ```bash git clone https://github.com/infiniflow/ragflow.git @@ -237,12 +237,12 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev . ## ๐Ÿ”จ Launch service from source for development -1. Install Poetry, if you already installed Poetry, please skip this step: +1. Install Poetry, or skip this step if it is already installed: ```bash curl -sSL https://install.python-poetry.org | python3 - ``` -2. Get RAGFlow source code and install Python dependencies: +2. Clone the source code and install Python dependencies: ```bash git clone https://github.com/infiniflow/ragflow.git cd ragflow/ @@ -250,37 +250,37 @@ docker build -f Dockerfile -t infiniflow/ragflow:dev . ~/.local/bin/poetry install --sync --no-root # install RAGFlow dependent python modules ``` -3. Launch the RAGFlow dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose: +3. Launch the dependent services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose: ```bash docker compose -f docker/docker-compose-base.yml up -d ``` - Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/service_conf.yaml** to `127.0.0.1`: + Add the following line to `/etc/hosts` to resolve all hosts specified in **docker/service_conf.yaml** to `127.0.0.1`: ``` 127.0.0.1 es01 mysql minio redis - ``` + ``` In **docker/service_conf.yaml**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**. -4. If you cannot access HuggingFace, set the HF_ENDPOINT environment variable to use a mirror site: +4. If you cannot access HuggingFace, set the `HF_ENDPOINT` environment variable to use a mirror site: ```bash export HF_ENDPOINT=https://hf-mirror.com ``` -5. Launch RAGFlow backend service: +5. Launch backend service: ```bash source .venv/bin/activate export PYTHONPATH=$(pwd) bash docker/launch_backend_service.sh ``` -6. Install frontend dependencies: +6. Install frontend dependencies: ```bash cd web npm install --force - ``` + ``` 7. Configure frontend to update `proxy.target` in **.umirc.ts** to `http://127.0.0.1:9380`: -8. Launch RAGFlow frontend service: +8. Launch frontend service: ```bash npm run dev ``` From ff73c014b1413a21154befe40897eb469f9e5546 Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Sun, 29 Sep 2024 16:22:28 +0800 Subject: [PATCH 7/8] Fixed Signed-off-by: Jin Hai --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f4acee0b9f..95f82f4fbe 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,8 @@ - ๐Ÿ”Ž [System Architecture](#-system-architecture) - ๐ŸŽฌ [Get Started](#-get-started) - ๐Ÿ”ง [Configurations](#-configurations) -- ๐Ÿช› [Build docker image without embedding models](#-build-docker-image-without-embedding-models) -- ๐Ÿชš [Build docker image with embedding models](#-build-docker-image-with-embedding-models) +- ๐Ÿช› [Build the docker image without embedding models](#-build-the-docker-image-without-embedding-models) +- ๐Ÿชš [Build the docker image including embedding models](#-build-the-docker-image-including-embedding-models) - ๐Ÿ”จ [Launch service from source for development](#-launch-service-from-source-for-development) - ๐Ÿ“š [Documentation](#-documentation) - ๐Ÿ“œ [Roadmap](#-roadmap) @@ -211,9 +211,9 @@ Updates to the above configurations require a reboot of all containers to take e > $ docker-compose -f docker/docker-compose.yml up -d > ``` -## ๐Ÿช› Build docker image without embedding models +## ๐Ÿช› Build the Docker image without embedding models -This image is approximately 1 GB in size and relies on external LLM and embedding services, as it only includes document parsing models. +This image is approximately 1 GB in size and relies on external LLM and embedding services. ```bash git clone https://github.com/infiniflow/ragflow.git @@ -223,9 +223,9 @@ python3 download_deps.py # embedding models docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ``` -## ๐Ÿชš Build docker image with embedding models +## ๐Ÿชš Build the Docker image including embedding models -This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes document parsing and embedding models. +This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes embedding models. ```bash git clone https://github.com/infiniflow/ragflow.git From 3856eb786927aef59430f26357ff66188ac81dab Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Sun, 29 Sep 2024 16:27:35 +0800 Subject: [PATCH 8/8] Fix Signed-off-by: Jin Hai --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 95f82f4fbe..5bac9faffa 100644 --- a/README.md +++ b/README.md @@ -225,7 +225,7 @@ docker build -f Dockerfile.slim -t infiniflow/ragflow:dev-slim . ## ๐Ÿชš Build the Docker image including embedding models -This image's size is approximately 9 GB in size and can reference via either local CPU/GPU or an external LLM, as it includes embedding models. +This image includes embedding models and is approximately 9 GB in size, and so relies on external LLM services only. ```bash git clone https://github.com/infiniflow/ragflow.git