MemoryOS

环境要求

• Python 环境（可执行 python3 与 pip，用于安装 requirements.txt 依赖）
• 有效的 OpenAI API Key（或兼容 OpenAI 的自定义 BASE_URL）
• 可选：NVIDIA GPU 与 nvidia-container-toolkit（README 的 Docker 示例使用 --gpus=all）
• 已安装 Docker（使用 Docker 方式部署时需要）

安装与启动步骤

1. 1获取项目代码

   克隆 GitHub 仓库到本地，之后所有安装与运行操作都在仓库目录内进行。

   git clone https://github.com/BAI-LAB/MemoryOS.git

   复制

2. 2安装 MCP 依赖

   进入 memoryos-mcp 子目录，按官方 requirements.txt 安装依赖，建议使用虚拟环境。

   cd memoryos-mcp
   pip install -r requirements.txt

   复制

3. 3填写 MCP 配置

   编辑 memoryos-mcp/config.json，填入 user_id、OpenAI API Key、BASE_URL、模型与存储路径。

4. 4调用 Python API

   按 PyPI 基本用法初始化 Memoryos，写入一条记忆再查询，记得把 API Key 换成自己的。

   import os
   from memoryos import Memoryos
   
   USER_ID = "demo_user"
   ASSISTANT_ID = "demo_assistant"
   API_KEY = "sk-xxxxxxxx"
   BASE_URL = ""
   DATA_STORAGE_PATH = "./simple_demo_data"
   LLM_MODEL = "gpt-4o-mini"
   
   memo = Memoryos(
       user_id=USER_ID,
       openai_api_key=API_KEY,
       openai_base_url=BASE_URL,
       data_storage_path=DATA_STORAGE_PATH,
       llm_model=LLM_MODEL,
       assistant_id=ASSISTANT_ID,
       short_term_capacity=7,
       mid_term_heat_threshold=5,
       retrieval_queue_capacity=7,
       long_term_knowledge_capacity=100,
       embedding_model_name="BAAI/bge-m3"
   )
   
   memo.add_memory(
       user_input="Hi! I'm Tom, I work as a data scientist in San Francisco.",
       agent_response="Hello Tom! Nice to meet you. Data science is such an exciting field. What kind of data do you work with?"
   )
   
   response = memo.get_response(query="What do you remember about my job?")
   print(response)

   复制

5. 5启动 Playground

   进入 memdemo 目录运行 app.py，打开界面后填写 User ID、API Key、Model 与 API Base URL。

   cd MemoryOS/memoryos-playground/memdemo/
   python3 app.py

   复制

6. 6Docker 方式运行

   在含有 Dockerfile 的目录构建镜像并进入容器；没有 GPU 时去掉 --gpus=all 参数。

   docker build -t memoryos .
   docker run -it --gpus=all memoryos /bin/bash

   复制

关键配置

如何确认成功

Python 示例会打印 “MemoryOS initialized successfully!” 并返回针对记忆查询的 Assistant 回复，即初始化与读写成功。

常见问题

注意事项

• README 中 PyPI 的 “Installation” 小节没有给出具体安装命令，安装方式请以官方文档 https://bai-lab.github.io/MemoryOS/docs 为准。
• 仓库还提供 memoryos-chromadb 目录，可进入后执行 pip install -r requirements.txt 安装对应依赖。
• 运行 Python 示例或 Playground 前，务必把示例中的 YOUR_OPENAI_API_KEY / sk-xxxxxxxx 替换为真实密钥，避免泄露到公开仓库。
• Docker 构建前请确认当前目录存在 Dockerfile。