revise readme and framework pickture

This commit is contained in:
青轩 2024-08-23 16:23:08 +08:00
parent bd954fe7c4
commit d9186f42dd
4 changed files with 23 additions and 46 deletions

View file

@ -56,51 +56,20 @@ from the aggregation of similarly-themed *observations*.
accurate relevant information when the query involves reference to time.
### Example Usages
## 🚀 Installation
For installation, please refer to [Installation.md](docs/Installation.md).
### One-key Demo Run
Run `sudo docker run -it --rm --net=host memoryscope/memoryscope` to launch memoryscope cli demo.
## Example Usages
- [Simple Usages (Quick Start)](./examples/api/simple_usages_en.ipynb)
- [CLI with a MemoryScope Chatbot](./examples/cli/dash_cli_cn1.sh)
- [Advanced Customization](./examples/api/advanced_customization_en.ipynb)
## 🚀 Installation
### (1) Docker-Compose (Recommended)
1. Clone the project and edit the config.
```
git clone https://...
vim memoryscope/core/config/demo_config.yaml
```
2. Edit `docker-compose.yml` to change environment variable.
```
DASHSCOPE_API_KEY: "sk-0000000000"
```
3. Run `docker-compose up` to build and launch the memory-scope cli interface.
### (2) Docker
1. Clone the project and edit the config.
```
git clone https://...
vim memoryscope/core/config/demo_config.yaml
```
2. Build the `Dockerfile` with command:
```
sudo docker build --network=host -t memoryscope .
```
3. Launch the built image with command:
```
sudo docker run -it --rm --net=host memoryscope
```
## 💡 Contribute
Contributions are always encouraged!

View file

@ -46,12 +46,22 @@ MemoryScope 是一个为LLM聊天机器人服务的强大且灵活的长期记
⏰ 时间敏感性:
- T系统在执行记忆检索和记忆巩固时具备时间敏感性,因此在输入对话包含对时间的指涉时,可以检索到准确的相关信息。
## 🚀 安装
完整的安装方法请参考[Installation.md](docs/Installation.md)。
### 一键运行Demo
运行 `sudo docker run -it --rm --net=host memoryscope/memoryscope` 一键运行memoryscope的演示。
### 用法示例
- [简易用法(快速开始)](./examples/api/simple_usages_cn.ipynb)
- [在命令行与MemoryScope聊天机器人交互](./examples/cli/dash_cli_cn1.sh)
- [进阶自定义用法](./examples/api/advanced_customization_cn.ipynb)
## 🚀 安装
## 💡 代码贡献
@ -64,8 +74,6 @@ poetry install --with dev
pre-commit install
```
## 📖 引用
如果您在论文中有使用该项目,请添加以下引用:

View file

@ -4,7 +4,7 @@
1. Clone the repository and edit settings
```bash
# clone project
git clone https://...
git clone https://github.com/modelscope/memoryscope
cd memoryscope
# edit configuration, e.g. add api keys
vim memoryscope/core/config/demo_config.yaml
@ -28,7 +28,7 @@
1. Clone the repository and edit settings
```bash
# clone project
git clone https://...
git clone https://github.com/modelscope/memoryscope
cd memoryscope
# edit configuration, e.g. add api keys
vim memoryscope/core/config/demo_config.yaml
@ -48,7 +48,7 @@
1. Clone the repository and edit settings
```bash
# clone project
git clone https://...
git clone https://github.com/modelscope/memoryscope
cd memoryscope
# edit configuration, e.g. add api keys
vim memoryscope/core/config/demo_config.yaml

Binary file not shown.

Before

Width:  |  Height:  |  Size: 230 KiB

After

Width:  |  Height:  |  Size: 221 KiB