Skip to content

Commit

Permalink
update logo size & update version (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
jinliyl authored Sep 11, 2024
1 parent 54f3bbf commit f60cf00
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 15 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
English | [**中文**](./README_ZH.md)

# MemoryScope

![MemoryScope Logo](./docs/images/logo.png)

<p align="center">
<img src="./docs/images/logo.png" alt="MemoryScopeLogo" width="75%">
</p>
Equip your LLM chatbot with a powerful and flexible long term memory system.

[![](https://img.shields.io/badge/python-3.10+-blue)](https://pypi.org/project/memoryscope/)
[![](https://img.shields.io/badge/pypi-v0.1.1-blue?logo=pypi)](https://pypi.org/project/memoryscope/)
[![](https://img.shields.io/badge/pypi-v0.1.1.0-blue?logo=pypi)](https://pypi.org/project/memoryscope/)
[![](https://img.shields.io/badge/license-Apache--2.0-black)](./LICENSE)
[![](https://img.shields.io/badge/Docs-English%7C%E4%B8%AD%E6%96%87-blue?logo=markdown)](https://modelscope.github.io/memoryscope/#welcome-to-memoryscope-tutorial-hub)
[![](https://img.shields.io/badge/Docs-API_Reference-blue?logo=markdown)](https://modelscope.github.io/memoryscope/)
Expand All @@ -16,18 +16,22 @@ Equip your LLM chatbot with a powerful and flexible long term memory system.
----
## 📰 News

- **[2024-09-10]** We release MemoryScope v0.1.1 now, which is also available in [PyPI](https://pypi.org/simple/memoryscope/)!
- **[2024-09-10]** We release MemoryScope v0.1.1.0 now, which is also available in [PyPI](https://pypi.org/simple/memoryscope/)!
----
## 🌟 What is MemoryScope?
MemoryScope provides LLM chatbots with powerful and flexible long-term memory capabilities, offering a framework for building such abilities.
It can be applied to scenarios like personal assistants and emotional companions, continuously learning through long-term memory to remember users' basic information as well as various habits and preferences.
This allows users to gradually experience a sense of "understanding" when using the LLM.

### Demo
![english-gif](https://github.com/user-attachments/assets/1754c814-1342-4288-a8a3-74d0b40f59a6)
<p align="center">
<img src="https://github.com/user-attachments/assets/1754c814-1342-4288-a8a3-74d0b40f59a6" alt="en_demo" width="75%">
</p>

### Framework
![Framework](./docs/images/framework.png)
<p align="center">
<img src="./docs/images/framework.png" alt="Framework" width="75%">
</p>

💾 Memory Database: MemoryScope is equipped with a vector database (default is *ElasticSearch*) to store all memory fragments recorded in the system.

Expand Down
17 changes: 11 additions & 6 deletions README_ZH.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[**English**](./README.md) | 中文

# MemoryScope

![MemoryScope Logo](./docs/images/logo.png)

<p align="center">
<img src="./docs/images/logo.png" alt="MemoryScopeLogo" width="75%">
</p>
为您的大语言模型聊天机器人配备强大且灵活的长期记忆系统。

[![](https://img.shields.io/badge/python-3.10+-blue)](https://pypi.org/project/memoryscope/)
Expand All @@ -21,18 +21,23 @@
----
## 📰 新闻

- **[2024-09-10]** 我们现在发布了 MemoryScope v0.1.1,该版本也可以在 [PyPI](https://pypi.org/simple/memoryscope/) 上获取!
- **[2024-09-10]** 我们现在发布了 MemoryScope v0.1.1.0,该版本也可以在 [PyPI](https://pypi.org/simple/memoryscope/) 上获取!
----

## 🌟 什么是MemoryScope?
MemoryScope可以为LLM聊天机器人提供强大且灵活的长期记忆能力,并提供了构建长期记忆能力的框架。
MemoryScope可以用于个人助理、情感陪伴等记忆场景,通过长期记忆能力来不断学习,记得用户的基础信息以及各种习惯和喜好,使得用户在使用LLM时逐渐感受到一种“默契”。

### Demo
![chinese-gif](https://github.com/user-attachments/assets/57519274-8c01-4d88-bcd2-0ebce3551e5d)
<p align="center">
<img src="https://github.com/user-attachments/assets/57519274-8c01-4d88-bcd2-0ebce3551e5d" alt="zh_demo" width="75%">
</p>


### 核心框架:
![Framework](./docs/images/framework.png)
<p align="center">
<img src="./docs/images/framework.png" alt="Framework" width="75%">
</p>

💾 记忆数据库: MemoryScope配备了向量数据库(默认是*ElasticSearch*),用于存储系统中记录的所有记忆片段。

Expand Down
2 changes: 1 addition & 1 deletion memoryscope/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
""" Version of MemoryScope."""
__version__ = "0.1.0.10"
__version__ = "0.1.1.0"
import fire

from memoryscope.core.config.arguments import Arguments # noqa: F401
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def package_files(directory):

setuptools.setup(
name="memoryscope",
version="0.1.0.10",
version="0.1.1.0",
author=', '.join([author['name'] for author in authors]),
author_email=', '.join([author['email'] for author in authors]),
description="MemoryScope is a powerful and flexible long term memory system for LLM chatbots. It consists of a "
Expand Down

0 comments on commit f60cf00

Please sign in to comment.