Skip to content

Commit dad1751

Browse files
authored
chore: bump version to v0.1.13 (#48)
- Project Management: Added issue templates and updated pull request template for better contribution workflow Enhanced PR template for clarity and completeness - 📖 Documentation & Research: Published long version of MemOS paper Updated citations and references Migrated all documentation to dedicated MemOS-Docs repository Improved documentation structure and accessibility - 🧪 Evaluation & Testing: Added evaluation configuration examples Implemented run locomo eval script for performance testing Fixed redundant memory search branches in evaluation system - 🔧 Features & Functionality: Added internet retrieval capabilities to MemOS Implemented Chain-of-Thought (CoT) functionality Fixed ParsedTaskGoal usage in examples Added unrelated memory filtering functionality
2 parents 2e6f6e8 + 161010f commit dad1751

File tree

75 files changed

+3141
-4895
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+3141
-4895
lines changed

.github/CONTRIBUTING

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Please read https://memos.openmem.net/docs/contribution/overview to learn how to contribute to this repository. 🌟
2+
3+
请阅读 https://memos.openmem.net/docs/contribution/overview 了解如何为此项目贡献代码。🌟
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "\U0001F41B Bug / help"
2+
description: Create a report to help us improve MemOS
3+
labels: ["bug", "pending"]
4+
body:
5+
6+
- type: textarea
7+
id: system-info
8+
validations:
9+
required: true
10+
attributes:
11+
label: System Info
12+
description: |
13+
Please share your system info with us. You can run the command **pip show MemoryOS** and copy-paste its output below.
14+
请提供您的系统信息。您可以在命令行运行 **pip show MemoryOS** 并将其输出复制到该文本框中。
15+
16+
placeholder: MemoryOS version, platform, python version, ...
17+
18+
- type: textarea
19+
id: reproduction
20+
validations:
21+
required: true
22+
attributes:
23+
label: Reproduction
24+
description: |
25+
Please provide entry arguments, error messages and stack traces that reproduces the problem.
26+
请提供入口参数,错误日志以及异常堆栈以便于我们复现问题。
27+
28+
value: |
29+
```text
30+
Put your message here.
31+
```
32+
33+
- type: textarea
34+
id: others
35+
validations:
36+
required: false
37+
attributes:
38+
label: Others
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: "\U0001F680 Feature request"
2+
description: Submit a request for a new feature
3+
labels: ["enhancement", "pending"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please do not create issues that are not related to new features under this category.
9+
请勿在此分类下创建和新特性无关的 issues。
10+
11+
- type: checkboxes
12+
id: reminder
13+
attributes:
14+
label: Reminder
15+
description: |
16+
Please ensure you have read the above rules carefully and searched the existing issues.
17+
请确保您已经认真阅读了上述规则并且搜索过现有的 issues。
18+
19+
options:
20+
- label: I have read the above rules and searched the existing issues.
21+
required: true
22+
23+
- type: textarea
24+
id: description
25+
validations:
26+
required: true
27+
attributes:
28+
label: Description
29+
description: |
30+
A clear and concise description of the feature proposal.
31+
请详细描述您希望加入的新功能特性。
32+
33+
- type: textarea
34+
id: contribution
35+
validations:
36+
required: false
37+
attributes:
38+
label: Pull Request
39+
description: |
40+
Have you already created the relevant PR and submitted the code?
41+
您是否已经创建了相关 PR 并提交了代码?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,28 @@
11
## Description
22

3-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
3+
<!--
4+
Please include a summary of the changes below;
5+
Fill in the issue number that this PR addresses (if applicable);
6+
Mention the person who will review this PR (if you know who it is);
7+
Replace (summary), (issue), and (reviewer) with the appropriate information (No parentheses).
48
5-
Fixes # (issue)
9+
请在下方填写更改的摘要;
10+
填写此 PR 解决的问题编号(如果适用);
11+
提及将审查此 PR 的人(如果您知道是谁);
12+
替换 (summary)、(issue) 和 (reviewer) 为适当的信息(不带括号)。
13+
-->
614

7-
## Type of change
15+
Summary: (summary)
816

9-
Please delete options that are not relevant.
17+
Fix: #(issue)
1018

11-
- [ ] Bug fix (non-breaking change which fixes an issue)
12-
- [ ] New feature (non-breaking change which adds functionality)
13-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14-
- [ ] Refactor (does not change functionality, e.g. code style improvements, linting)
15-
- [ ] Documentation update
16-
17-
## How Has This Been Tested?
18-
19-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
20-
21-
Please delete options that are not relevant.
22-
23-
- [ ] Unit Test
24-
- [ ] Test Script (please provide)
19+
Reviewer: @(reviewer)
2520

2621
## Checklist:
2722

28-
- [ ] My code follows the style guidelines of this project
29-
- [ ] I have performed a self-review of my own code
30-
- [ ] I have commented my code, particularly in hard-to-understand areas
31-
- [ ] My changes generate no new warnings
32-
- [ ] I have added tests that prove my fix is effective or that my feature works
33-
- [ ] New and existing unit tests pass locally with my changes
34-
- [ ] I have checked my code and corrected any misspellings
35-
36-
## Maintainer Checklist
37-
38-
- [ ] closes #xxxx (Replace xxxx with the GitHub issue number)
39-
- [ ] Made sure Checks passed
23+
- [ ] I have performed a self-review of my own code | 我已自行检查了自己的代码
24+
- [ ] I have commented my code in hard-to-understand areas | 我已在难以理解的地方对代码进行了注释
25+
- [ ] I have added tests that prove my fix is effective or that my feature works | 我已添加测试以证明我的修复有效或功能正常
26+
- [ ] I have added necessary documentation (if applicable) | 我已添加必要的文档(如果适用)
27+
- [ ] I have linked the issue to this PR (if applicable) | 我已将 issue 链接到此 PR(如果适用)
28+
- [ ] I have mentioned the person who will review this PR | 我已提及将审查此 PR 的人

.github/workflows/python-tests.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
name: Python tests
55

6+
permissions:
7+
contents: read
8+
69
on:
710
push:
811
branches:
@@ -22,6 +25,10 @@ jobs:
2225
matrix:
2326
os:
2427
- "ubuntu-latest"
28+
- "windows-latest"
29+
- "macos-14"
30+
- "macos-15"
31+
# Ref: https://docs.github.com/en/actions/how-tos/writing-workflows/choosing-where-your-workflow-runs/choosing-the-runner-for-a-job
2532
python-version:
2633
- "3.10"
2734
- "3.11"
@@ -48,4 +55,4 @@ jobs:
4855
poetry run ruff format --check
4956
- name: Test with pytest
5057
run: |
51-
PYTHONPATH=src poetry run pytest tests -vv
58+
poetry run pytest tests -vv

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ evaluation/data/langmemeval
1010
evaluation/*tmp/
1111
evaluation/results
1212
evaluation/.env
13-
evaluation/scripts/*.sh
1413
evaluation/configs/*
1514
.env
1615

Makefile

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: test docs
1+
.PHONY: test
22

33
install:
44
poetry install --with dev --with test
@@ -11,7 +11,7 @@ clean:
1111
rm -rf tmp
1212

1313
test:
14-
PYTHONPATH=src poetry run pytest tests
14+
poetry run pytest tests
1515

1616
format:
1717
poetry run ruff check --fix
@@ -23,24 +23,5 @@ pre_commit:
2323
serve:
2424
poetry run uvicorn memos.api.start_api:app
2525

26-
docs:
27-
pytest tests/test_docs.py -xq
28-
pip install mkdocs mkdocs-material -q
29-
mkdir -p tmp
30-
rm -f tmp/mkdocs.yml
31-
echo "site_name: MemOS Documentation" > tmp/mkdocs.yml
32-
echo "docs_dir: `pwd`/docs" >> tmp/mkdocs.yml
33-
echo "theme: material" >> tmp/mkdocs.yml
34-
echo "markdown_extensions:" >> tmp/mkdocs.yml
35-
echo " - pymdownx.highlight:" >> tmp/mkdocs.yml
36-
echo " anchor_linenums: true" >> tmp/mkdocs.yml
37-
echo " line_spans: __span" >> tmp/mkdocs.yml
38-
echo " pygments_lang_class: true" >> tmp/mkdocs.yml
39-
echo " - pymdownx.inlinehilite" >> tmp/mkdocs.yml
40-
echo " - pymdownx.snippets" >> tmp/mkdocs.yml
41-
echo " - pymdownx.superfences" >> tmp/mkdocs.yml
42-
cat docs/settings.yml >> tmp/mkdocs.yml
43-
mkdocs serve -f tmp/mkdocs.yml --no-livereload
44-
4526
openapi:
4627
poetry run python scripts/export_openapi.py --output docs/openapi.json

README.md

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@
2222
<a href="https://memos.openmem.net/docs/home">
2323
<img src="https://img.shields.io/badge/Documentation-view-blue.svg" alt="Documentation">
2424
</a>
25-
<a href="https://arxiv.org/abs/2505.22101">
26-
<img src="https://img.shields.io/badge/arXiv-2505.22101-b31b1b.svg" alt="ArXiv Paper">
25+
<a href="https://arxiv.org/abs/2507.03724">
26+
<img src="https://img.shields.io/badge/arXiv-2507.03724-b31b1b.svg" alt="ArXiv Paper">
2727
</a>
2828
<a href="https://github.com/MemTensor/MemOS/discussions">
2929
<img src="https://img.shields.io/badge/GitHub-Discussions-181717.svg?logo=github" alt="GitHub Discussions">
3030
</a>
3131
<a href="https://discord.gg/Txbx3gebZR">
3232
<img src="https://img.shields.io/badge/Discord-join%20chat-7289DA.svg?logo=discord" alt="Discord">
3333
</a>
34-
<a href="docs/assets/memos-wechat-group.png">
34+
<a href="docs/assets/qr_code.png">
3535
<img src="https://img.shields.io/badge/WeChat-Group-07C160.svg?logo=wechat" alt="WeChat Group">
3636
</a>
3737
<a href="https://opensource.org/license/apache-2-0/">
@@ -43,7 +43,7 @@
4343
---
4444

4545
<a href="https://memos.openmem.net/">
46-
<img src="docs/assets/SOTA_Score.jpg" alt="SOTA SCORE">
46+
<img src="docs/assets/sota_score.jpg" alt="SOTA SCORE">
4747
</a>
4848

4949

@@ -151,7 +151,11 @@ For more detailed examples, please check out the [`examples`](./examples) direct
151151
## 📦 Installation
152152

153153
> [!WARNING]
154-
> Currently, MemOS primarily supports Linux platforms. You may encounter issues on Windows and macOS temporarily.
154+
> MemOS is compatible with Linux, Windows, and macOS.
155+
>
156+
> However, if you're using macOS, please note that there may be dependency issues that are difficult to resolve.
157+
>
158+
> For example, compatibility with macOS 13 Ventura is currently challenging.
155159
156160
### Install via pip
157161

@@ -192,24 +196,50 @@ Join our community to ask questions, share your projects, and connect with other
192196
- **Discord**: Join our <a href="https://discord.gg/Txbx3gebZR" target="_blank">Discord Server</a>.
193197
- **WeChat**: Scan the QR code to join our WeChat group.
194198

195-
<img src="docs/assets/qr-code.png" alt="QR Code" width="600">
199+
<img src="docs/assets/qr_code.png" alt="QR Code" width="600">
196200

197201
## 📜 Citation
198202

199-
If you use MemOS in your research, please cite our paper:
203+
> [!NOTE]
204+
> We publicly released the Short Version on **May 28, 2025**, making it the earliest work to propose the concept of a Memory Operating System for LLMs.
205+
206+
If you use MemOS in your research, we would appreciate citations to our papers.
200207

201208
```bibtex
202-
@article{li2025memos,
209+
210+
@article{li2025memos_long,
211+
title={MemOS: A Memory OS for AI System},
212+
author={Li, Zhiyu and Song, Shichao and Xi, Chenyang and Wang, Hanyu and Tang, Chen and Niu, Simin and Chen, Ding and Yang, Jiawei and Li, Chunyu and Yu, Qingchen and Zhao, Jihao and Wang, Yezhaohui and Liu, Peng and Lin, Zehao and Wang, Pengyuan and Huo, Jiahao and Chen, Tianyi and Chen, Kai and Li, Kehang and Tao, Zhen and Ren, Junpeng and Lai, Huayi and Wu, Hao and Tang, Bo and Wang, Zhenren and Fan, Zhaoxin and Zhang, Ningyu and Zhang, Linfeng and Yan, Junchi and Yang, Mingchuan and Xu, Tong and Xu, Wei and Chen, Huajun and Wang, Haofeng and Yang, Hongkang and Zhang, Wentao and Xu, Zhi-Qin John and Chen, Siheng and Xiong, Feiyu},
213+
journal={arXiv preprint arXiv:2507.03724},
214+
year={2025},
215+
url={https://arxiv.org/abs/2507.03724}
216+
}
217+
218+
@article{li2025memos_short,
203219
title={MemOS: An Operating System for Memory-Augmented Generation (MAG) in Large Language Models},
204220
author={Li, Zhiyu and Song, Shichao and Wang, Hanyu and Niu, Simin and Chen, Ding and Yang, Jiawei and Xi, Chenyang and Lai, Huayi and Zhao, Jihao and Wang, Yezhaohui and others},
205221
journal={arXiv preprint arXiv:2505.22101},
206-
year={2025}
222+
year={2025},
223+
url={https://arxiv.org/abs/2505.22101}
224+
}
225+
226+
@article{yang2024memory3,
227+
author = {Yang, Hongkang and Zehao, Lin and Wenjin, Wang and Wu, Hao and Zhiyu, Li and Tang, Bo and Wenqiang, Wei and Wang, Jinbo and Zeyun, Tang and Song, Shichao and Xi, Chenyang and Yu, Yu and Kai, Chen and Xiong, Feiyu and Tang, Linpeng and Weinan, E},
228+
title = {Memory$^3$: Language Modeling with Explicit Memory},
229+
journal = {Journal of Machine Learning},
230+
year = {2024},
231+
volume = {3},
232+
number = {3},
233+
pages = {300--346},
234+
issn = {2790-2048},
235+
doi = {https://doi.org/10.4208/jml.240708},
236+
url = {https://global-sci.com/article/91443/memory3-language-modeling-with-explicit-memory}
207237
}
208238
```
209239

210240
## 🙌 Contributing
211241

212-
We welcome contributions from the community! Please read our [contribution guidelines](./docs/contribution/overview.md) to get started.
242+
We welcome contributions from the community! Please read our [contribution guidelines](https://memos.openmem.net/docs/contribution/overview) to get started.
213243

214244
## 📄 License
215245

@@ -220,6 +250,7 @@ MemOS is licensed under the [Apache 2.0 License](./LICENSE).
220250
Stay up to date with the latest MemOS announcements, releases, and community highlights.
221251

222252
- **2025-07-07** – 🎉 *MemOS 1.0 (Stellar) Preview Release*: A SOTA Memory OS for LLMs is now open-sourced.
253+
- **2025-07-04** – 🎉 *MemOS Paper Released*: [MemOS: A Memory OS for AI System](https://arxiv.org/abs/2507.03724) was published on arXiv.
223254
- **2025-05-28** – 🎉 *Short Paper Uploaded*: [MemOS: An Operating System for Memory-Augmented Generation (MAG) in Large Language Models](https://arxiv.org/abs/2505.22101) was published on arXiv.
224255
- **2024-07-04** – 🎉 *Memory3 Model Released at WAIC 2024*: The new memory-layered architecture model was unveiled at the 2024 World Artificial Intelligence Conference.
225256
- **2024-07-01** – 🎉 *Memory3 Paper Released*: [Memory3: Language Modeling with Explicit Memory](https://arxiv.org/abs/2407.01178) introduces the new approach to structured memory in LLMs.

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
All documentation has been moved to a separate repository: https://github.com/MemTensor/MemOS-Docs. Please edit documentation there.
2+
3+
所有文档已迁移至独立仓库:https://github.com/MemTensor/MemOS-Docs。请在该仓库中编辑文档。

docs/assets/memos-architecture.png

-810 KB
Binary file not shown.

0 commit comments

Comments
 (0)