yangdx
commited on
Commit
·
e32da4a
1
Parent(s):
379efe1
Update README
Browse files- README-zh.md +4 -2
- README.md +3 -3
README-zh.md
CHANGED
@@ -91,7 +91,9 @@ python examples/lightrag_openai_demo.py
|
|
91 |
|
92 |
如需流式响应示例的实现代码,请参阅 `examples/lightrag_openai_compatible_demo.py`。运行前,请确保根据需求修改示例代码中的LLM及嵌入模型配置。
|
93 |
|
94 |
-
|
|
|
|
|
95 |
|
96 |
## 使用LightRAG Core进行编程
|
97 |
|
@@ -825,7 +827,7 @@ rag = LightRAG(
|
|
825 |
create INDEX CONCURRENTLY entity_idx_node_id ON dickens."Entity" (ag_catalog.agtype_access_operator(properties, '"node_id"'::agtype));
|
826 |
CREATE INDEX CONCURRENTLY entity_node_id_gin_idx ON dickens."Entity" using gin(properties);
|
827 |
ALTER TABLE dickens."DIRECTED" CLUSTER ON directed_sid_idx;
|
828 |
-
|
829 |
-- 如有必要可以删除
|
830 |
drop INDEX entity_p_idx;
|
831 |
drop INDEX vertex_p_idx;
|
|
|
91 |
|
92 |
如需流式响应示例的实现代码,请参阅 `examples/lightrag_openai_compatible_demo.py`。运行前,请确保根据需求修改示例代码中的LLM及嵌入模型配置。
|
93 |
|
94 |
+
**注意1**:在运行demo程序的时候需要注意,不同的测试程序可能使用的是不同的embedding模型,更换不同的embeding模型的时候需要把清空数据目录(`./dickens`),否则层序执行会出错。如果你想保留LLM缓存,可以在清除数据目录是保留`kv_store_llm_response_cache.json`文件。
|
95 |
+
|
96 |
+
**注意2**:官方支持的示例代码仅为 `lightrag_openai_demo.py` 和 `lightrag_openai_compatible_demo.py` 两个文件。其他示例文件均为社区贡献内容,尚未经过完整测试与优化。
|
97 |
|
98 |
## 使用LightRAG Core进行编程
|
99 |
|
|
|
827 |
create INDEX CONCURRENTLY entity_idx_node_id ON dickens."Entity" (ag_catalog.agtype_access_operator(properties, '"node_id"'::agtype));
|
828 |
CREATE INDEX CONCURRENTLY entity_node_id_gin_idx ON dickens."Entity" using gin(properties);
|
829 |
ALTER TABLE dickens."DIRECTED" CLUSTER ON directed_sid_idx;
|
830 |
+
|
831 |
-- 如有必要可以删除
|
832 |
drop INDEX entity_p_idx;
|
833 |
drop INDEX vertex_p_idx;
|
README.md
CHANGED
@@ -127,9 +127,9 @@ python examples/lightrag_openai_demo.py
|
|
127 |
|
128 |
For a streaming response implementation example, please see `examples/lightrag_openai_compatible_demo.py`. Prior to execution, ensure you modify the sample code’s LLM and embedding configurations accordingly.
|
129 |
|
130 |
-
**Note**: When running the demo program, please be aware that different test scripts may use different embedding models. If you switch to a different embedding model, you must clear the data directory (`./dickens`); otherwise, the program may encounter errors. If you wish to retain the LLM cache, you can preserve the `kv_store_llm_response_cache.json` file while clearing the data directory.
|
131 |
|
132 |
-
|
133 |
|
134 |
## Programing with LightRAG Core
|
135 |
|
@@ -847,7 +847,7 @@ For production level scenarios you will most likely want to leverage an enterpri
|
|
847 |
create INDEX CONCURRENTLY entity_idx_node_id ON dickens."Entity" (ag_catalog.agtype_access_operator(properties, '"node_id"'::agtype));
|
848 |
CREATE INDEX CONCURRENTLY entity_node_id_gin_idx ON dickens."Entity" using gin(properties);
|
849 |
ALTER TABLE dickens."DIRECTED" CLUSTER ON directed_sid_idx;
|
850 |
-
|
851 |
-- drop if necessary
|
852 |
drop INDEX entity_p_idx;
|
853 |
drop INDEX vertex_p_idx;
|
|
|
127 |
|
128 |
For a streaming response implementation example, please see `examples/lightrag_openai_compatible_demo.py`. Prior to execution, ensure you modify the sample code’s LLM and embedding configurations accordingly.
|
129 |
|
130 |
+
**Note 1**: When running the demo program, please be aware that different test scripts may use different embedding models. If you switch to a different embedding model, you must clear the data directory (`./dickens`); otherwise, the program may encounter errors. If you wish to retain the LLM cache, you can preserve the `kv_store_llm_response_cache.json` file while clearing the data directory.
|
131 |
|
132 |
+
**Note 2**: Only `lightrag_openai_demo.py` and `lightrag_openai_compatible_demo.py` are officially supported sample codes. Other sample files are community contributions that haven't undergone full testing and optimization.
|
133 |
|
134 |
## Programing with LightRAG Core
|
135 |
|
|
|
847 |
create INDEX CONCURRENTLY entity_idx_node_id ON dickens."Entity" (ag_catalog.agtype_access_operator(properties, '"node_id"'::agtype));
|
848 |
CREATE INDEX CONCURRENTLY entity_node_id_gin_idx ON dickens."Entity" using gin(properties);
|
849 |
ALTER TABLE dickens."DIRECTED" CLUSTER ON directed_sid_idx;
|
850 |
+
|
851 |
-- drop if necessary
|
852 |
drop INDEX entity_p_idx;
|
853 |
drop INDEX vertex_p_idx;
|