Skip to content

Commit

Permalink
revise readme and framework pickture
Browse files Browse the repository at this point in the history
  • Loading branch information
binary-husky committed Aug 23, 2024
1 parent bd954fe commit d9186f4
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 44 deletions.
45 changes: 7 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,50 +56,19 @@ from the aggregation of similarly-themed *observations*.
accurate relevant information when the query involves reference to time.


### 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
For installation, please refer to [Installation.md](docs/Installation.md).

### (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"
```
### One-key Demo Run

3. Run `docker-compose up` to build and launch the memory-scope cli interface.
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)

### (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

Expand Down
14 changes: 11 additions & 3 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

## 🚀 安装


## 💡 代码贡献

Expand All @@ -64,8 +74,6 @@ poetry install --with dev
pre-commit install
```



## 📖 引用

如果您在论文中有使用该项目,请添加以下引用:
Expand Down
6 changes: 3 additions & 3 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
Binary file modified docs/images/framework.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d9186f4

Please sign in to comment.