MemoryScope 安装指南

一、使用 Docker 安装 [推荐]

克隆仓库并编辑配置

# 克隆项目
git clone https://github.com/modelscope/memoryscope
cd memoryscope
# 编辑配置，例如添加 API 密钥
vim memoryscope/core/config/demo_config_zh.yaml

构建 Docker 镜像
```
sudo docker build --network=host -t memoryscope .
```
备注：如果是arm架构的电脑，则必须使用另一个命令：sudo docker build -f DockerfileArm --network=host -t memoryscope .

启动 Docker 容器

sudo docker run -it --rm --net=host memoryscope

[!Important] 如果需要观察Memory的变化请调整第3步的运行命令。首先执行 sudo docker run -it --name=memoryscope_container --rm --net=host memoryscope启动memoryscope；
然后新建命令行窗口，运行sudo docker exec -it memoryscope_container python quick-start-demo.py --config_path=memoryscope/core/config/demo_config_zh.yaml；
在第二个窗口，继续输入/list_memory refresh_time=5来检查实时的memory

二、使用 Docker Compose 安装 [推荐] [x86_64]

克隆仓库并编辑配置

# 克隆项目
git clone https://github.com/modelscope/memoryscope
cd memoryscope
# 编辑配置，例如添加 API 密钥
vim memoryscope/core/config/demo_config_zh.yaml

编辑 docker-compose.yml 文件以更改环境变量。
```
DASHSCOPE_API_KEY: "sk-0000000000"
```
运行 docker-compose run memory_scope_main 命令来构建并启动 MemoryScope CLI 界面。(备注：如果是arm架构，还需要手动将docker-compose.yml中的ghcr.io/modelscope/memoryscope:main修改成ghcr.io/modelscope/memoryscope_arm:main)

三、通过 PYPI 安装

从 PyPI 安装：
```
pip install memoryscope
```

运行 Elasticsearch 服务，参照 Elasticsearch 文档。推荐使用 Docker 方法：

sudo docker run -p 9200:9200 \
-e "discovery.type=single-node" \
-e "xpack.security.enabled=false" \
-e "xpack.license.self_generated.type=trial" \
docker.elastic.co/elasticsearch/elasticsearch:8.13.2

测试中文 / Dashscope 对话配置：

export DASHSCOPE_API_KEY="sk-0000000000"
memoryscope --language="cn" \
        --memory_chat_class="cli_memory_chat" \
        --human_name="用户" \
        --assistant_name="AI" \
        --generation_backend="dashscope_generation" \
        --generation_model="qwen-max" \
        --embedding_backend="dashscope_embedding" \
        --embedding_model="text-embedding-v2" \
        --enable_ranker=True \
        --rank_backend="dashscope_rank" \
        --rank_model="gte-rerank"

测试英文 / OpenAI 对话配置：

export OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
memoryscope --language="en" \
        --memory_chat_class="cli_memory_chat" \
        --human_name="User" \
        --assistant_name="AI" \
        --generation_backend="openai_generation" \
        --generation_model="gpt-4o" \
        --embedding_backend="openai_embedding" \
        --embedding_model="text-embedding-3-small" \
        --enable_ranker=False

四、从源码安装

克隆仓库并编辑设置

# 克隆项目
git clone https://github.com/modelscope/memoryscope
cd memoryscope
# 编辑配置，例如添加 API 密钥
vim memoryscope/core/config/demo_config_zh.yaml

安装依赖
```
pip install -e .
```

运行 Elasticsearch 服务，参照 Elasticsearch 文档。推荐使用 Docker 方法：

sudo docker run -p 9200:9200 \
-e "discovery.type=single-node" \
-e "xpack.security.enabled=false" \
-e "xpack.license.self_generated.type=trial" \
docker.elastic.co/elasticsearch/elasticsearch:8.13.2

启动 MemoryScope，同时参考 CLI 文档

export DASHSCOPE_API_KEY="sk-0000000000"
python quick-start-demo.py --config_path=memoryscope/core/config/demo_config_zh.yaml