Skip to content

Commit e04213f

Browse files
committed
docs: 更新文档内容及修正描述
- 在branding.md中添加主题配置说明 - 修正knowledge-base.md中查询逻辑的描述 - 更新evaluation.md中字段说明和数据集构建提示
1 parent 8d97a33 commit e04213f

File tree

4 files changed

+7
-9
lines changed

4 files changed

+7
-9
lines changed

docs/latest/advanced/branding.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,6 @@ YUXI_BRAND_FILE_PATH=src/config/static/info.local.yaml
4646
--main-900: #e6f7ff; /* 色板 */
4747
/* ... 其他色板 */
4848
}
49+
50+
**此外**,`web/src/stores/theme.js` 中也包含了主题相关的配置(需要修改 `colorPrimary`),可根据需要修改。
4951
```

docs/latest/intro/evaluation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919
```
2020

2121
**字段说明**
22-
- `query`(必需):测试问题
23-
- `gold_chunk_ids`(可选):相关文档块的 ID 列表
24-
- `gold_answer`(可选):标准答案
22+
- `query`(必需):测试问题,用于触发 RAG 系统的检索
23+
- `gold_chunk_ids`(可选):相关文档块的 ID 列表,用于验证检索效果
24+
- `gold_answer`(可选):标准答案,用于验证生成效果
2525

2626
::: tip 数据集构建
27-
可以使用 [EasyDataset](https://github.com/ConardLi/easy-dataset) 从文档批量生成问答对、可视化编辑、导出多种格式和数据质量检查。挺好用的,推荐。注意导出的时候的字段需要修改为 `query``gold_chunk_ids``gold_answer`
27+
可以使用 [EasyDataset](https://github.com/ConardLi/easy-dataset) 从文档批量生成问答对、可视化编辑、导出多种格式和数据质量检查。挺好用的,推荐。注意导出的时候的字段需要修改为 `query``gold_answer`
2828
:::
2929

3030

docs/latest/intro/knowledge-base.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,6 @@ LightRAG 知识库可在知识库详情中可视化,但不支持在侧边栏
7575
- 带有 Entity 标签的节点
7676
- 带有 RELATION 类型的关系边
7777

78-
注意:
79-
80-
这里仅展示用户上传的实体和关系,不包含知识库中自动创建的图谱。
81-
查询逻辑基于 `graphbase.py` 中的 `get_sample_nodes` 方法实现:
8278

8379
```SQL
8480
MATCH (n:Entity)-[r]->(m:Entity)

docs/v0.3.0/intro/knowledge-base.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ LightRAG 知识库可在知识库详情中可视化,但不支持在侧边栏
8080
注意:
8181

8282
这里仅展示用户上传的实体和关系,不包含知识库中自动创建的图谱。
83-
查询逻辑基于 `graphbase.py` 中的 `get_sample_nodes` 方法实现
83+
查询逻辑基于图谱适配器的子图查询方法实现
8484

8585
```SQL
8686
MATCH (n:Entity)-[r]->(m:Entity)

0 commit comments

Comments
 (0)