jinhai-2012 commited on
Commit
d88713b
·
1 Parent(s): ef1bf1e

Update README (#670)

Browse files

### What problem does this PR solve?

_Briefly describe what this PR aims to solve. Include background context
that will help reviewers understand the purpose of the PR._

### Type of change

- [x] Documentation Update

---------

Signed-off-by: Jin Hai <[email protected]>

Files changed (3) hide show
  1. README.md +10 -9
  2. README_ja.md +4 -1
  3. README_zh.md +5 -3
README.md CHANGED
@@ -58,14 +58,14 @@
58
 
59
  ## 📌 Latest Features
60
 
61
- - 2024-04-26 Add file management.
62
- - 2024-04-19 Support conversation API ([detail](./docs/conversation_api.md)).
63
- - 2024-04-16 Add an embedding model 'bce-embedding-base_v1' from [BCEmbedding](https://github.com/netease-youdao/BCEmbedding).
64
- - 2024-04-16 Add [FastEmbed](https://github.com/qdrant/fastembed), which is designed specifically for light and speedy embedding.
65
- - 2024-04-11 Support [Xinference](./docs/xinference.md) for local LLM deployment.
66
- - 2024-04-10 Add a new layout recognization model for analyzing Laws documentation.
67
- - 2024-04-08 Support [Ollama](./docs/ollama.md) for local LLM deployment.
68
- - 2024-04-07 Support Chinese UI.
69
 
70
  ## 🔎 System Architecture
71
 
@@ -119,6 +119,7 @@
119
  $ chmod +x ./entrypoint.sh
120
  $ docker compose up -d
121
  ```
 
122
 
123
  > The core image is about 9 GB in size and may take a while to load.
124
 
@@ -180,7 +181,7 @@ To build the Docker images from source:
180
  ```bash
181
  $ git clone https://github.com/infiniflow/ragflow.git
182
  $ cd ragflow/
183
- $ docker build -t infiniflow/ragflow:v0.5.0 .
184
  $ cd ragflow/docker
185
  $ chmod +x ./entrypoint.sh
186
  $ docker compose up -d
 
58
 
59
  ## 📌 Latest Features
60
 
61
+ - 2024-05-08 Integrates LLM DeepSeek.
62
+ - 2024-04-26 Adds file management.
63
+ - 2024-04-19 Supports conversation API ([detail](./docs/conversation_api.md)).
64
+ - 2024-04-16 Integrates an embedding model 'bce-embedding-base_v1' from [BCEmbedding](https://github.com/netease-youdao/BCEmbedding), and [FastEmbed](https://github.com/qdrant/fastembed), which is designed specifically for light and speedy embedding.
65
+ - 2024-04-11 Supports [Xinference](./docs/xinference.md) for local LLM deployment.
66
+ - 2024-04-10 Adds a new layout recognition model for analyzing Laws documentation.
67
+ - 2024-04-08 Supports [Ollama](./docs/ollama.md) for local LLM deployment.
68
+ - 2024-04-07 Supports Chinese UI.
69
 
70
  ## 🔎 System Architecture
71
 
 
119
  $ chmod +x ./entrypoint.sh
120
  $ docker compose up -d
121
  ```
122
+ > Please note that running the above commands will automatically download the development version docker image of RAGFlow. If you want to download and run a specific version of docker image, please find the RAGFLOW_VERSION variable in the docker/.env file, change it to the corresponding version, for example, RAGFLOW_VERSION=v0.5.0, and run the above commands.
123
 
124
  > The core image is about 9 GB in size and may take a while to load.
125
 
 
181
  ```bash
182
  $ git clone https://github.com/infiniflow/ragflow.git
183
  $ cd ragflow/
184
+ $ docker build -t infiniflow/ragflow:dev .
185
  $ cd ragflow/docker
186
  $ chmod +x ./entrypoint.sh
187
  $ docker compose up -d
README_ja.md CHANGED
@@ -58,6 +58,7 @@
58
 
59
  ## 📌 最新の機能
60
 
 
61
  - 2024-04-26 「ファイル管理」機能を追加しました。
62
  - 2024-04-19 会話 API をサポートします ([詳細](./docs/conversation_api.md))。
63
  - 2024-04-16 [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) から埋め込みモデル「bce-embedding-base_v1」を追加します。
@@ -120,7 +121,9 @@
120
  $ docker compose up -d
121
  ```
122
 
123
- > コアイメージのサイズは約 15 GB で、ロードに時間がかかる場合があります。
 
 
124
 
125
  4. サーバーを立ち上げた後、サーバーの状態を確認する:
126
 
 
58
 
59
  ## 📌 最新の機能
60
 
61
+ - 2024-05-08
62
  - 2024-04-26 「ファイル管理」機能を追加しました。
63
  - 2024-04-19 会話 API をサポートします ([詳細](./docs/conversation_api.md))。
64
  - 2024-04-16 [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) から埋め込みモデル「bce-embedding-base_v1」を追加します。
 
121
  $ docker compose up -d
122
  ```
123
 
124
+ > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.5.0として、上記のコマンドを実行してください。
125
+
126
+ > コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
127
 
128
  4. サーバーを立ち上げた後、サーバーの状態を確認する:
129
 
README_zh.md CHANGED
@@ -58,10 +58,10 @@
58
 
59
  ## 📌 新增功能
60
 
 
61
  - 2024-04-26 增添了'文件管理'功能.
62
  - 2024-04-19 支持对话 API ([更多](./docs/conversation_api.md)).
63
- - 2024-04-16 添加嵌入模型 [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) 。
64
- - 2024-04-16 添加 [FastEmbed](https://github.com/qdrant/fastembed) 专为轻型和高速嵌入而设计。
65
  - 2024-04-11 支持用 [Xinference](./docs/xinference.md) 本地化部署大模型。
66
  - 2024-04-10 为‘Laws’版面分析增加了底层模型。
67
  - 2024-04-08 支持用 [Ollama](./docs/ollama.md) 本地化部署大模型。
@@ -120,7 +120,9 @@
120
  $ docker compose -f docker-compose-CN.yml up -d
121
  ```
122
 
123
- > 核心镜像文件大约 15 GB,可能需要一定时间拉取。请耐心等待。
 
 
124
 
125
  4. 服务器启动成功后再次确认服务器状态:
126
 
 
58
 
59
  ## 📌 新增功能
60
 
61
+ - 2024-05-08 集成大模型 DeepSeek
62
  - 2024-04-26 增添了'文件管理'功能.
63
  - 2024-04-19 支持对话 API ([更多](./docs/conversation_api.md)).
64
+ - 2024-04-16 集成嵌入模型 [BCEmbedding](https://github.com/netease-youdao/BCEmbedding) 和 专为轻型和高速嵌入而设计的 [FastEmbed](https://github.com/qdrant/fastembed)
 
65
  - 2024-04-11 支持用 [Xinference](./docs/xinference.md) 本地化部署大模型。
66
  - 2024-04-10 为‘Laws’版面分析增加了底层模型。
67
  - 2024-04-08 支持用 [Ollama](./docs/ollama.md) 本地化部署大模型。
 
120
  $ docker compose -f docker-compose-CN.yml up -d
121
  ```
122
 
123
+ > 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.5.0,然后运行上述命令。
124
+
125
+ > 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
126
 
127
  4. 服务器启动成功后再次确认服务器状态:
128