writinwaters commited on
Commit
e3fa72e
Β·
1 Parent(s): 58d441f

Update README.md (#179)

Browse files
Files changed (1) hide show
  1. README.md +24 -23
README.md CHANGED
@@ -26,22 +26,23 @@
26
  [RAGFlow](http://demo.ragflow.io) is a knowledge management platform built on custom-build document understanding engine and LLM, with reasoned and well-founded answers to your question. Clone this repository, you can deploy your own knowledge management platform to empower your business with AI.
27
 
28
  ## 🌟 Key Features
29
-
30
- - 🍭**Custom-build document understanding engine.** Our deep learning engine is made according to the needs of analyzing and searching various type of documents in different domain.
31
- - For documents from different domain for different purpose, the engine applies different analyzing and search strategy.
32
- - Easily intervene and manipulate the data proccessing procedure when things goes beyond expectation.
33
- - Multi-media document understanding is supported using OCR and multi-modal LLM.
34
- - 🍭**State-of-the-art table structure and layout recognition.** Precisely extract and understand the document including table content. See [README.](./deepdoc/README.md)
35
- - For PDF files, layout and table structures including row, column and span of them are recognized.
36
- - Put the table accrossing the pages together.
37
- - Reconstruct the table structure components into html table.
38
- - **Querying database dumped data are supported.** After uploading tables from any database, you can search any data records just by asking.
39
- - You can now query a database using natural language instead of using SQL.
40
- - The record number uploaded is not limited.
41
- - **Reasoned and well-founded answers.** The cited document part in LLM's answer is provided and pointed out in the original document.
42
- - The answers are based on retrieved result for which we apply vector-keyword hybrids search and re-rank.
43
- - The part of document cited in the answer is presented in the most expressive way.
44
- - For PDF file, the cited parts in document can be located in the original PDF.
 
45
 
46
  ## πŸ”Ž System Architecture
47
 
@@ -97,7 +98,7 @@
97
 
98
  > The core image is about 15 GB in size and may take a while to load.
99
 
100
- 4. Check the server status after pulling all images and having Docker up and running:
101
  ```bash
102
  $ docker logs -f ragflow-server
103
  ```
@@ -117,9 +118,9 @@
117
  INFO:werkzeug:Press CTRL+C to quit
118
  ```
119
 
120
- 5. In your web browser, enter the IP address of your server as prompted.
121
 
122
- *The show is on!*
123
 
124
 
125
  ## πŸ”§ Configurations
@@ -128,14 +129,14 @@ When it comes to system configurations, you will need to manage the following fi
128
 
129
  - [.env](./docker/.env): Keeps the fundamental setups for the system, such as `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, and `MINIO_PASSWORD`.
130
  - [service_conf.yaml](./docker/service_conf.yaml): Configures the back-end services.
131
- - [docker-compose.yml](./docker-compose.yaml): The system relies on [docker-compose.yml](./docker-compose.yaml) to start up.
132
 
133
 
134
- You must ensure that changes in [.env](./docker/.env) are in line with what are in the [service_conf.yaml](./docker/service_conf.yaml) file.
135
 
136
- > The [./docker/README](./docker/README.md) file provides a detailed description of the environment settings and service configurations, and it is IMPORTANT to ensure that all environment settings listed in the [./docker/README](./docker/README.md) file should be aligned with the corresponding settings in the [service_conf.yaml](./docker/service_conf.yaml) file.
137
 
138
- To change the default serving port (80), go to [docker-compose.yml](./docker-compose.yaml) and change `80:80` to `<YOUR_SERVING_PORT>:80`.
139
 
140
  > Updates to all system configurations require a system reboot to take effect:
141
  >
 
26
  [RAGFlow](http://demo.ragflow.io) is a knowledge management platform built on custom-build document understanding engine and LLM, with reasoned and well-founded answers to your question. Clone this repository, you can deploy your own knowledge management platform to empower your business with AI.
27
 
28
  ## 🌟 Key Features
29
+
30
+ - 🍭 **"Quality in, quality out"**
31
+ - Deep document understanding-based knowledge extraction from unstructured data with complicated formats.
32
+ - Finds "needle in a data haystack" of literally unlimited tokens.
33
+ - 🍱 **Template-based chunking**
34
+ - Intelligent and explainable.
35
+ - Plenty of template options to choose from.
36
+ - 🌱 **Grounded citations with reduced hallucinations**
37
+ - Visualization of text chunking to allow human intervention.
38
+ - Quick view of the key references and traceable citations to support grounded answers.
39
+ - πŸ” **Compatibility with heterogeneous data sources**
40
+ - Supports Word, slides, excel, txt, images, scanned copies, structured data, web pages, and more.
41
+ - πŸ›€ **Automated and effortless RAG workflow**
42
+ - Streamlined RAG orchestration catered to both personal and large businesses.
43
+ - Configurable LLMs as well as embedding models.
44
+ - Multiple recall paired with fused re-ranking.
45
+ - Intuitive APIs for seamless integration with business.
46
 
47
  ## πŸ”Ž System Architecture
48
 
 
98
 
99
  > The core image is about 15 GB in size and may take a while to load.
100
 
101
+ 4. Check the server status after having the server up and running:
102
  ```bash
103
  $ docker logs -f ragflow-server
104
  ```
 
118
  INFO:werkzeug:Press CTRL+C to quit
119
  ```
120
 
121
+ 5. In your web browser, enter the IP address of your server as prompted and log in to RAGFlow.
122
 
123
+ *The show is now on!*
124
 
125
 
126
  ## πŸ”§ Configurations
 
129
 
130
  - [.env](./docker/.env): Keeps the fundamental setups for the system, such as `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, and `MINIO_PASSWORD`.
131
  - [service_conf.yaml](./docker/service_conf.yaml): Configures the back-end services.
132
+ - [docker-compose.yml](./docker/docker-compose.yml): The system relies on [docker-compose.yml](./docker/docker-compose.yml) to start up.
133
 
134
 
135
+ You must ensure that changes to the [.env](./docker/.env) file are in line with what are in the [service_conf.yaml](./docker/service_conf.yaml) file.
136
 
137
+ > The [./docker/README](./docker/README.md) file provides a detailed description of the environment settings and service configurations, and it is IMPORTANT to ensure that all environment settings listed in the [./docker/README](./docker/README.md) file are aligned with the corresponding configurations in the [service_conf.yaml](./docker/service_conf.yaml) file.
138
 
139
+ To change the default serving port (80), go to [docker-compose.yml](./docker/docker-compose.yml) and change `80:80` to `<YOUR_SERVING_PORT>:80`.
140
 
141
  > Updates to all system configurations require a system reboot to take effect:
142
  >