Skip to content

Commit 520afd2

Browse files
committed
docs: 更新文档内容与格式
- 修正知识库支持说明,移除"仅"字 - 更新模型配置文档的步骤编号 - 修复FAQ标题格式 - 优化项目概述的格式 - 更新快速开始指南的版本信息 - 完善知识库文档,明确LightRAG与全局图谱区别
1 parent 15a7a32 commit 520afd2

File tree

7 files changed

+19
-10
lines changed

7 files changed

+19
-10
lines changed

docs/latest/changelog/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,5 @@
6666
- RapidOCR 本地模型:确保 `MODEL_DIR/SWHL/RapidOCR` 下存在 `PP-OCRv4` 模型
6767
- MinerU/PaddleX:检查健康检查接口与 GPU/CUDA 版本
6868

69-
- 登录失败被锁定?
69+
### 登录失败被锁定?
7070
- 多次失败会临时锁定账户,请根据提示等待后重试

docs/latest/changelog/roadmap.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
- 优化chunk逻辑,移除 QA 分割,集成到普通分块中
1414
- 考虑修改附件的处理逻辑,考虑使用文件系统,将附件解析后放到文件系统中,智能体按需读取,用户可以使用 @ 来引用附件,例如 @file:reports.md 相较于现在的处理逻辑感觉会更加自然一点。在此之前可能还要考虑文件系统的后端支持问题
1515
- skills 如何实现还需要继续调研
16+
- 优化 paddle 的命名,paddlex 有歧义,修改为 PP-StructureV3
17+
- 增加 paddle-vl 以及 deepseek-ocr 的支持
1618

1719
### Bugs
1820
- 部分异常状态下,智能体的模型名称出现重叠[#279](https://github.com/xerrors/Yuxi-Know/issues/279)

docs/latest/intro/evaluation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**适用场景**:验证知识库上线前的效果、对比不同配置下的检索效果、定期监控知识库质量变化、调优检索参数。
66

7-
**注意**当前版本仅支持 Milvus 类型的知识库。
7+
**注意**当前版本支持 Milvus 类型的知识库。
88

99
## 如何创建评估基准
1010

docs/latest/intro/knowledge-base.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
| 存储类型 | 特点 | 适用场景 |
1010
|----------|------|----------|
11-
| **Chroma** | 轻量级向量数据库 | 小型项目、快速原型、维护方便(后续会移除) |
11+
| **Chroma** | 轻量级向量数据库 | 已弃用,建议使用 Milvus |
1212
| **Milvus** | 高性能向量数据库 | 大规模生产环境、高性能查询 |
1313
| **LightRAG** | 图增强检索 | 复杂知识关系,构建成本较高 |
1414

@@ -19,7 +19,15 @@
1919

2020
### LightRAG 知识库说明
2121

22-
在本项目中,系统支持基于 [LightRAG](https://github.com/HKUDS/LightRAG) 的知识图谱自动构建,能够从文档中自动提取实体和关系,构建结构化知识图谱。但是 LightRAG 所构建的知识图谱不作为全局的知识图谱来使用。只是将 LightRAG 作为知识的组织和检索形式。一方面是因为 LightRAG 构建的图谱的质量比较差,另一方面是不希望与全局的知识图谱弄混。
22+
在本项目中,系统支持基于 [LightRAG](https://github.com/HKUDS/LightRAG) 的知识图谱自动构建,能够从文档中自动提取实体和关系,构建结构化知识图谱。
23+
24+
**LightRAG 图谱 vs 全局知识图谱的区别:**
25+
26+
- **LightRAG 图谱**(知识库专属):针对单个知识库由 LightRAG 自动抽取实体/关系,用于该库内的图增强检索与可视化。通过特殊的 label(知识库ID)与全局图谱区分,不会混入全局数据。
27+
28+
- **全局知识图谱**(系统级):通过三元组文件上传的图谱数据,提供系统级的知识图谱查询和可视化能力,会作为工具供 LLM 使用。
29+
30+
两者共享同一个 Neo4j 实例,但完全隔离,互不影响。
2331

2432
LightRAG 知识库可在知识库详情、知识图谱中可视化。由于免费版的 neo4j 智能创建一个图数据库,因此实际上 LightRAG 的节点和边依然是和知识图谱本身构建在了同一个 Neo4j 数据库中,但是使用了特殊的 label `{知识库ID}` 做区分。
2533

docs/latest/intro/model-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ config.reranker_names["local/reranker-model"] = RerankerInfo(
210210
config.save()
211211
```
212212

213-
#### 2. 启动模型服务
213+
#### 3. 启动模型服务
214214

215215
```bash
216216
# 启动嵌入模型

docs/latest/intro/project-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Yuxi-Know(语析)是一个基于知识图谱和向量数据库的智能知识库系统,融合了 RAG(检索增强生成)技术与知识图谱技术,为用户提供智能问答和知识管理服务。
44

5-
特点是技术栈简单,易于上手,使用 MIT 开源协议,非常适合二次开发使用。
5+
**特点**:技术栈简单,易于上手,使用 MIT 开源协议,非常适合二次开发使用。
66

77
### 技术栈选择
88

docs/latest/intro/quick-start.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 快速开始指南
22

33
::: tip 提示
4-
除了此文档网站外,小伙伴们还可以在 [Zread](https://zread.ai/xerrors/Yuxi-Know)[DeepWiki](https://deepwiki.com/xerrors/Yuxi-Know) 平台查看自动生成的详细项目文档。
4+
除了此文档网站外,用户还可以在 [Zread](https://zread.ai/xerrors/Yuxi-Know)[DeepWiki](https://deepwiki.com/xerrors/Yuxi-Know) 平台查看自动生成的详细项目文档。
55
:::
66

77

@@ -16,13 +16,12 @@
1616

1717
```bash
1818
# 克隆稳定版本
19-
git clone --branch v0.4.0-beta --depth 1 https://github.com/xerrors/Yuxi-Know.git
19+
git clone --branch v0.4.0 --depth 1 https://github.com/xerrors/Yuxi-Know.git
2020
cd Yuxi-Know
2121
```
2222

2323
::: warning 版本说明
24-
- `v0.3.0`: 稳定版本
25-
- `v0.4.0-beta`:最新的 Beta 测试版
24+
- `v0.4.0`: 稳定版本
2625
- `main`: 最新开发版本(不稳定,新特性可能会导致新 bug)
2726
:::
2827

0 commit comments

Comments
 (0)