diff --git a/docs/installation.md b/docs/installation.md index fcaa589d..9d9644c2 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -21,6 +21,10 @@ sudo docker run -it --rm --net=host memoryscope ``` +> [!Important] +> To inspect memory shift during the conversation, modify command in step 3 to `sudo docker run -it --name=memoryscope_container --rm --net=host memoryscope`;
+> Then start a new terminal window and execute `sudo docker exec -it memoryscope_container python quick-start-demo.py --config_path=memoryscope/core/config/demo_config_zh.yaml`;
+> In the second window, input `/list_memory refresh_time=5` to inspect memory ## II. Install with docker compose [Recommended] [x86_64] diff --git a/docs/installation_zh.md b/docs/installation_zh.md index 388ddf91..fbab9e88 100644 --- a/docs/installation_zh.md +++ b/docs/installation_zh.md @@ -22,6 +22,10 @@ ``` +> [!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] diff --git a/examples/cli/CLI_README.md b/examples/cli/CLI_README.md index 5c747311..f247ff4e 100644 --- a/examples/cli/CLI_README.md +++ b/examples/cli/CLI_README.md @@ -53,3 +53,12 @@ Here are the available options that can be set through either method: - `--enable_ranker`: A boolean indicating whether to use a dummy ranker (default is `False`). - `--rank_backend`: The backend used for ranking responses. - `--rank_model`: The model used for ranking responses. + +### 3. View Memory +You can open two command line windows following the method in the second step. +In one command line window, you can have a conversation with the AI, while in the other, you can check the AI's long-term memory about the user. +Use /help to open the command line help, and find the command /list_memory along with the corresponding auto-refresh instruction. +``` +/list_memory refresh_time=5 +``` +Then you can enjoy a pleasant conversation with the AI! \ No newline at end of file diff --git a/examples/cli/CLI_README_ZH.md b/examples/cli/CLI_README_ZH.md index 4ba1c640..b9debdda 100644 --- a/examples/cli/CLI_README_ZH.md +++ b/examples/cli/CLI_README_ZH.md @@ -53,3 +53,12 @@ memoryscope --language="en" \ - `--enable_ranker`: 一个布尔值,指示是否使用排名器(默认为 False)。 - `--rank_backend`: 用于排名回复的后端。 - `--rank_model`: 用于排名回复的模型。 + +### 3. 查看记忆 +按照第二步的方式可以打开两个命令行的窗口。 +其中一个命令行窗口可以和AI进行对话,另一个命令行窗口可以查看AI关于用户的长期记忆 +使用/help打开命令行帮助,找到/list_memory的命令和对应自动刷新的指令。 +``` +/list_memory refresh_time=5 +``` +接下来就可以和AI进行愉快地交流啦。 \ No newline at end of file