From 1576d7172d9dd0752cfe8baf1e6ffcc487d79eb0 Mon Sep 17 00:00:00 2001 From: "jinli.yl" Date: Sun, 1 Sep 2024 16:58:15 +0800 Subject: [PATCH] modify readme --- .pre-commit-config.yaml | 1 - README_ZH.md | 30 ++++++------------------------ clear-vector-store.py | 4 ++-- 3 files changed, 8 insertions(+), 27 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6b06513e..0b14959e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -24,7 +24,6 @@ repos: rev: v0.23.1 hooks: - id: toml-sort-fix - exclude: ".*poetry.lock" - repo: https://github.com/srstevenson/nb-clean rev: 3.1.0 hooks: diff --git a/README_ZH.md b/README_ZH.md index 516c6bb6..009af6d5 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -2,10 +2,7 @@ # MemoryScope -![MemoryScope Logo](./docs/images/logo_1.png) -

- MemoryScope Logo -

+![MemoryScope Logo](./docs/images/logo.png) 为您的大语言模型聊天机器人配备强大且灵活的长期记忆系统。 @@ -16,7 +13,7 @@ [![](https://img.shields.io/badge/license-Apache--2.0-black)](./LICENSE) [![](https://img.shields.io/badge/Contribute-Welcome-green)](https://modelscope.github.io/memoryscope/tutorial/contribute.html) - @@ -24,31 +21,16 @@ ---- ## 新闻 -- **[2024-09-02]** 我们现在发布了 MemoryScope v0.1.1，该版本也可以在 [PyPI](https://pypi.org/simple) 上获取！ +- **[2024-09-02]** 我们现在发布了 MemoryScope v0.1.1，该版本也可以在 [PyPI](https://pypi.org/simple/memoryscope/) 上获取！ ---- ## 什么是MemoryScope？ - -💾 记忆数据库: -- MemoryScope 配备了一个 *ElasticSearch (ES)* 向量数据库，用于存储系统中记录的所有记忆片段。 - -🛠️ 系统操作: -- 记忆检索：当用户输入对话，此操作返回语义相关的记忆片段。如果输入对话包含对时间的指涉，则同时返回相应时间中的记忆片段。 -- 记忆巩固：此操作接收一批用户的输入对话，并从对话中提取重要的用户信息，将其作为 *observation* 形式的记忆片段存储在记忆数据库中。 -- 反思与再巩固：每隔一段时间，此操作对新记录的 *observations* 进行反思，以形成和更新 *insight* 形式的记忆片段。然后执行记忆再巩固， -以确保记忆片段之间的矛盾和重复得到妥善处理。 - -### 框架 MemoryScope可以为LLM聊天机器人提供强大且灵活的长期记忆能力，并提供了构建长期记忆能力的框架。 MemoryScope可以用于个人助理、情感陪伴等记忆场景，通过长期记忆能力来不断学习，记得用户的基础信息以及各种习惯和喜好，使得用户在使用LLM时逐渐感受到一种“默契”。 -

- MemoryScope Framework -

-![MemoryScope Logo](./docs/images/framework.png) +![Framework](./docs/images/framework.png) -### 主要特点 -### 长期记忆的框架： +### 核心框架： 💾 记忆数据库: MemoryScope配备了向量数据库(默认是*ElasticSearch*)，用于存储系统中记录的所有记忆片段。 @@ -113,7 +95,7 @@ MemoryScope可以用于个人助理、情感陪伴等记忆场景，通过长期 ## 快速开始 - [简易用法（快速开始）](./examples/api/simple_usages_cn.ipynb) -- [在命令行与MemoryScope聊天机器人交互](./examples/cli/README.md) +- [在命令行与MemoryScope聊天机器人交互](./examples/cli/README_ZH.md) - [进阶自定义用法](./examples/advance/custom_operator.md) diff --git a/clear-vector-store.py b/clear-vector-store.py index 6371d0d4..7092d332 100644 --- a/clear-vector-store.py +++ b/clear-vector-store.py @@ -22,5 +22,5 @@ arguments = Arguments( ) ms = MemoryScope(arguments=arguments) -msms = ms._context.memory_store.es_store -msms.sync_delete_all() +es_store = ms.context.memory_store.es_store +es_store.sync_delete_all()