From 21f310823da5fca3810f8b17b88bb8bc6cde6442 Mon Sep 17 00:00:00 2001 From: "jinli.yl" Date: Mon, 22 Jun 2026 15:17:34 +0800 Subject: [PATCH] docs(reme): update package data configuration and rename readme - Remove reme package data entry from pyproject.toml - Rename README.md to README_ZH.md - Add design philosophy section explaining Memory as File concept - Document progressive knowledge abstraction process - Describe semantic similarity to relationship graph approach - Update package data configuration for tokenizer component --- README.md => README_ZH.md | 8 ++++++++ pyproject.toml | 1 - {reme/skills => skills}/claude_code_memory/SKILL.md | 0 {reme/skills => skills}/qwenpaw_memory/SKILL.md | 0 {reme/skills => skills}/reme_memory/SKILL.md | 0 5 files changed, 8 insertions(+), 1 deletion(-) rename README.md => README_ZH.md (92%) rename {reme/skills => skills}/claude_code_memory/SKILL.md (100%) rename {reme/skills => skills}/qwenpaw_memory/SKILL.md (100%) rename {reme/skills => skills}/reme_memory/SKILL.md (100%) diff --git a/README.md b/README_ZH.md similarity index 92% rename from README.md rename to README_ZH.md index 47c5423d..25902f4c 100644 --- a/README.md +++ b/README_ZH.md @@ -36,6 +36,14 @@ - **渐进式混合搜索**：融合 wikilink、BM25 和 embedding，支持从关键词到语义与关系扩展的混合检索。 - **Agent 友好集成**：通过 SKILL.md + CLI 接入，方便不同 Agent 读写、维护和复用记忆。 +## 🧭 设计理念 + +ReMe 的设计围绕三件事展开：把记忆落到可读写的文件，把知识从原始材料渐进抽象为长期记忆，再用显式链接把知识组织成 Agent 可以展开和推理的关系图。 + +- **基础：Memory as File**。ReMe 不把长期记忆锁在黑盒数据库或隐式 prompt 中，而是以 Markdown、JSONL、YAML 和资源文件承载记忆。文件既是用户可直接检查、修改和迁移的知识资产，也是 Agent 可读写、可索引、可链接的操作界面。 +- **核心：渐进式知识抽象**。原始对话和资料先保存在 `session/` 与 `resource/` 中，`auto_memory` 和 `auto_resource` 将它们加工为 `daily/` 中的浅层记忆，再由 `auto_dream` 抽取、合并和修正为 `digest/` 中的长期知识。这个过程不是一次性总结，而是从原始知识到浅加工、再到深加工的持续沉淀。 +- **创新：从语义相似到关系图谱**。ReMe 使用 wikilink 表达显式知识关系，让记忆之间不只依赖 embedding 的语义相似，还能表达因果、上下游、来源、依赖、竞争等结构化关系。例如在金融场景中，可以把企业、行业、商品和事件连接成上游、下游、影响和风险链路，支持 Agent 从一个命中节点沿图谱渐进式展开上下文。 +
适用场景 diff --git a/pyproject.toml b/pyproject.toml index 8023c378..bd5cbb8f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -72,7 +72,6 @@ include-package-data = true [tool.setuptools.package-data] "*" = ["py.typed", "**/*.yaml", "**/*.json"] -"reme" = ["skills/**/*"] "reme.components.tokenizer" = ["stopwords"] [tool.setuptools.dynamic] diff --git a/reme/skills/claude_code_memory/SKILL.md b/skills/claude_code_memory/SKILL.md similarity index 100% rename from reme/skills/claude_code_memory/SKILL.md rename to skills/claude_code_memory/SKILL.md diff --git a/reme/skills/qwenpaw_memory/SKILL.md b/skills/qwenpaw_memory/SKILL.md similarity index 100% rename from reme/skills/qwenpaw_memory/SKILL.md rename to skills/qwenpaw_memory/SKILL.md diff --git a/reme/skills/reme_memory/SKILL.md b/skills/reme_memory/SKILL.md similarity index 100% rename from reme/skills/reme_memory/SKILL.md rename to skills/reme_memory/SKILL.md