Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,25 @@ Match the surrounding code style, avoid unrelated formatting changes, and add
a regression test for a behavior fix. Documentation-only changes should pass
the link checks; include a minimal before/after example when explaining a bug.

## Maintaining documentation

- Keep track guides in `docs/user_memory/` and `docs/agent_memory/`, with
`README.md` for English and `README_zh.md` for Chinese. Use the existing
`name.md` / `name_zh.md` convention for other paired pages; avoid renaming URLs
just for style.
- Update both languages when changing guide sections, commands, options, or
required setup. Translate explanations, not product names, paths, or flags.
- Maintain numeric result tables only in each track's English `results.md`.
Chinese result pages provide translated context and links to the canonical
tables rather than copying scores. Keep methodology explanations aligned.
- Keep parameter defaults, dataset/license details, and test commands in their
existing reference files; link to them instead of duplicating full references.
Distinguish bounded smoke checks, full evaluations, and destructive operations.
- Check file links and preserve existing heading anchors with aliases when
reorganizing sections.
The automated link checker validates relative file targets, not anchors or
external URLs.

## Adding a User Memory adapter

The public entry points use `add(messages, user_id, ...)` and
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ hf download EverMind-AI/EvoAgentBench \
## Results

- User Memory public result snapshot: [docs/user_memory/results.md](./docs/user_memory/results.md)
- AgentBench evaluation results: [docs/agent_memory/results.md](./docs/agent_memory/results.md)
- Agent Memory evaluation results: [docs/agent_memory/results.md](./docs/agent_memory/results.md)

Documentation index: [docs/README.md](./docs/README.md)

Expand Down
4 changes: 2 additions & 2 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ hf download EverMind-AI/EvoAgentBench \

## 结果

- User Memory 公开结果快照(英文):[docs/user_memory/results.md](./docs/user_memory/results.md)
- AgentBench 评测结果:[docs/agent_memory/results_zh.md](./docs/agent_memory/results_zh.md)
- User Memory 评测结果:[中文说明与结果表入口](./docs/user_memory/results_zh.md)
- Agent Memory 评测结果:[中文说明与结果表入口](./docs/agent_memory/results_zh.md)

文档索引:[docs/README_zh.md](./docs/README_zh.md)

Expand Down
16 changes: 15 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,25 @@ matches the system you want to evaluate:
| Track | Evaluation target | Guide | Results |
|---|---|---|---|
| User Memory Evaluation | Memory backend APIs exposed through `add()` and `search()` | [Guide](./user_memory/README.md) | [Results](./user_memory/results.md) |
| Agent Memory Evaluation | Agent runtimes equipped with memory plugins | [Guide](./agent_memory/README.md) | [Results](./agent_memory/results.md) |
| Agent Memory Evaluation | Agent runtimes with or without memory plugins | [Guide](./agent_memory/README.md) | [Results](./agent_memory/results.md) |

Agent Memory contributors can also read the current
[architecture and extension contracts](./agent_memory/architecture.md).

## Reading path

Each track guide follows the same sequence: overview, environment/configuration,
data preparation, quick start, advanced runs, outputs/results, and contribution.
User Memory additionally introduces its five benchmarks. Start with the bounded
quick-start check before launching complete runs; both call real services.

English and Chinese guides maintain matching sections and runnable commands.
Numeric result tables are maintained only in the English result pages; Chinese
result pages explain the metrics and link to those tables. Product names and
code identifiers are kept unchanged across languages.

## Related references

Related documentation remains next to the files it describes:

- Dataset preparation and licenses: `data/<benchmark>/README.md`
Expand Down
23 changes: 17 additions & 6 deletions docs/README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,29 @@ OmniMemEval 包含两条互补的评测线。请根据待评测对象选择对

| 评测线 | 评测对象 | 指南 | 结果 |
|---|---|---|---|
| User Memory Evaluation | 通过 `add()` 和 `search()` 暴露能力的 Memory Backend API | [指南](./user_memory/README_zh.md) | [结果(英文)](./user_memory/results.md) |
| Agent Memory Evaluation | 安装记忆插件后的 Agent Runtime | [指南](./agent_memory/README_zh.md) | [结果](./agent_memory/results_zh.md) |
| User Memory Evaluation(用户记忆评测) | 通过 `add()` 和 `search()` 暴露能力的记忆后端 API | [指南](./user_memory/README_zh.md) | [结果](./user_memory/results_zh.md) |
| Agent Memory Evaluation(智能体记忆评测) | 有无记忆插件时的智能体运行时 | [指南](./agent_memory/README_zh.md) | [结果](./agent_memory/results_zh.md) |

参与 Agent Memory 开发时,还可以阅读当前的
[架构与扩展契约](./agent_memory/architecture_zh.md)。

## 阅读顺序

两份运行指南采用相同顺序:概览、环境与配置、数据准备、快速开始、进阶运行、
输出与结果、扩展与贡献。User Memory 另外介绍五个 benchmark。
建议先运行有明确范围限制的快速检查,再运行完整评测;两者都会调用真实服务。

中英文指南保持章节与可执行命令对应。结果数值只在英文结果页维护,
中文结果页提供指标说明和表格入口。产品名与代码标识在两种语言中保持原样。

## 相关参考

与具体文件直接相关的文档继续就近维护:

- 数据准备与许可证:`data/<benchmark>/README.md`
- 环境模板与参数:
[env_examples/README.md](../env_examples/README.md) 和
[env_examples/PARAMETERS.md](../env_examples/PARAMETERS.md)
- 测试命令:[scripts/tests/README.md](../scripts/tests/README.md)
[env_examples/README.md(英文)](../env_examples/README.md) 和
[env_examples/PARAMETERS.md(英文)](../env_examples/PARAMETERS.md)
- 测试命令:[scripts/tests/README.md(英文)](../scripts/tests/README.md)
- 开发与结果提交规范:[CONTRIBUTING.md(英文)](../CONTRIBUTING.md)
- 第三方归属:[THIRD_PARTY_NOTICES.md](../THIRD_PARTY_NOTICES.md)
- 第三方归属:[THIRD_PARTY_NOTICES.md(英文)](../THIRD_PARTY_NOTICES.md)
Loading
Loading