writinwaters
commited on
Commit
Β·
e3fa72e
1
Parent(s):
58d441f
Update README.md (#179)
Browse files
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 |
-
-
|
31 |
-
-
|
32 |
-
-
|
33 |
-
|
34 |
-
-
|
35 |
-
-
|
36 |
-
|
37 |
-
-
|
38 |
-
-
|
39 |
-
|
40 |
-
-
|
41 |
-
- **
|
42 |
-
-
|
43 |
-
-
|
44 |
-
-
|
|
|
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
|
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.
|
132 |
|
133 |
|
134 |
-
You must ensure that changes
|
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
|
137 |
|
138 |
-
To change the default serving port (80), go to [docker-compose.yml](./docker-compose.
|
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 |
>
|