revise documents

This commit is contained in:
fuqingxu.fqx 2024-09-04 11:41:52 +08:00 committed by jinli.yl
parent 8157ca43f0
commit a34cab13ba
6 changed files with 47 additions and 4 deletions

View file

@ -86,10 +86,10 @@ For installation, please refer to [Installation.md](docs/installation.md).
## Example Usages
- [Simple Usages (Quick Start)](./examples/api/simple_usages_en.ipynb)
- [With AutoGen](./examples/api/autogen_example.md)
- [CLI with a MemoryScope Chatbot](./examples/cli/README.md)
- [Advanced Customization](./examples/advance/custom_operator.md)
## 💡 Contribute
Contributions are always encouraged!

View file

@ -99,6 +99,7 @@ MemoryScope可以用于个人助理、情感陪伴等记忆场景通过长期
- [简易用法(快速开始)](./examples/api/simple_usages_cn.ipynb)
- [在命令行与MemoryScope聊天机器人交互](./examples/cli/README_ZH.md)
- [进阶自定义用法](./examples/advance/custom_operator.md)
- [结合AutoGen使用](./examples/api/autogen_example.md)
## 💡 代码贡献

View file

@ -5,8 +5,6 @@ This script purges the entire vector store !
"""
import sys
sys.path.append(".")
from memoryscope import MemoryScope, Arguments
arguments = Arguments(

View file

@ -0,0 +1,22 @@
# Working with AgentScope
1. First, make sure that you have installed AutoGen as well as memoryscope.
```
pip install agentscope memoryscope
```
2. Then, ensure that es is up and running. [elasticsearch documents](https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started.html).
The docker method is recommended:
```
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
```
3. Finally, we can start the autogen demo.
```
python examples/api/agentscope_example.py
```

View file

@ -0,0 +1,22 @@
# Working with AutoGen
1. First, make sure that you have installed AutoGen as well as memoryscope.
```
pip install pyautogen memoryscope
```
2. Then, ensure that es is up and running. [elasticsearch documents](https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started.html).
The docker method is recommended:
```
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
```
3. Finally, we can start the autogen demo.
```
python examples/api/autogen_example.py
```

View file

@ -27,7 +27,7 @@ class MemoryScopeAgent(ConversableAgent):
self.memory_scope = MemoryScope(arguments=arguments)
self.memory_chat = self.memory_scope.default_memory_chat
self.register_reply([Agent, None], MemoryScopeAgent.generate_reply_with_memory,remove_other_reply_funcs=True)
self.register_reply([Agent, None], MemoryScopeAgent.generate_reply_with_memory, remove_other_reply_funcs=True)
def generate_reply_with_memory(