Skip to content

Commit 7361640

Browse files
committed
doc: Update readme
1 parent 65a2daf commit 7361640

File tree

6 files changed

+24
-131
lines changed

6 files changed

+24
-131
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,27 @@ showcasing its capabilities in **information extraction**, **temporal and cross-
8181

8282
## 🚀 Getting Started
8383

84+
### ⭐️ MemOS online API
85+
The easiest way to use MemOS. Equip your agent with memory **in minutes**!
86+
87+
Sign up and get started on[`MemOS dashboard`](https://memos-dashboard.openmem.net/cn/quickstart/?source=landing).
88+
89+
90+
### Self-Hosted Server
91+
1. Get the repository.
92+
```bash
93+
git clone https://github.com/MemTensor/MemOS.git
94+
cd MemOS
95+
pip install -r ./docker/requirements.txt
96+
```
97+
98+
2. Configure `docker/.env.example` and copy to `MemOS/.env`
99+
3. Start the service.
100+
```bash
101+
uvicorn memos.api.server_api:app --host 0.0.0.0 --port 8001 --workers 8
102+
```
103+
104+
### Local SDK
84105
Here's a quick example of how to create a **`MemCube`**, load it from a directory, access its memories, and save it.
85106

86107
```python
@@ -102,7 +123,7 @@ for item in mem_cube.act_mem.get_all():
102123
mem_cube.dump("tmp/mem_cube")
103124
```
104125

105-
What about **`MOS`** (Memory Operating System)? It's a higher-level orchestration layer that manages multiple MemCubes and provides a unified API for memory operations. Here's a quick example of how to use MOS:
126+
**`MOS`** (Memory Operating System) is a higher-level orchestration layer that manages multiple MemCubes and provides a unified API for memory operations. Here's a quick example of how to use MOS:
106127

107128
```python
108129
from memos.configs.mem_os import MOSConfig

evaluation/.env-example

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,3 @@ SUPERMEMORY_API_KEY="sm_xxx"
2222
MEMOBASE_API_KEY="xxx"
2323
MEMOBASE_PROJECT_URL="http://***.***.***.***:8019"
2424

25-
# eval settings
26-
PRE_SPLIT_CHUNK=false
27-
28-
# Configuration Only For Scheduler
29-
# RabbitMQ Configuration
30-
MEMSCHEDULER_RABBITMQ_HOST_NAME=rabbitmq-cn-***.cn-***.amqp-32.net.mq.amqp.aliyuncs.com
31-
MEMSCHEDULER_RABBITMQ_USER_NAME=***
32-
MEMSCHEDULER_RABBITMQ_PASSWORD=***
33-
MEMSCHEDULER_RABBITMQ_VIRTUAL_HOST=memos
34-
MEMSCHEDULER_RABBITMQ_ERASE_ON_CONNECT=true
35-
MEMSCHEDULER_RABBITMQ_PORT=5672
36-
37-
# OpenAI Configuration
38-
MEMSCHEDULER_OPENAI_API_KEY=sk-***
39-
MEMSCHEDULER_OPENAI_BASE_URL=http://***.***.***.***:3000/v1
40-
MEMSCHEDULER_OPENAI_DEFAULT_MODEL=gpt-4o-mini
41-
42-
# Graph DB Configuration
43-
MEMSCHEDULER_GRAPHDBAUTH_URI=bolt://localhost:7687
44-
MEMSCHEDULER_GRAPHDBAUTH_USER=neo4j
45-
MEMSCHEDULER_GRAPHDBAUTH_PASSWORD=***
46-
MEMSCHEDULER_GRAPHDBAUTH_DB_NAME=neo4j
47-
MEMSCHEDULER_GRAPHDBAUTH_AUTO_CREATE=true

evaluation/README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,7 @@ This repository provides tools and scripts for evaluating the `LoCoMo`, `LongMem
1616
```
1717

1818
## Configuration
19-
20-
1. Copy the `.env-example` file to `.env`, and fill in the required environment variables according to your environment and API keys.
21-
22-
2. Copy the `configs-example/` directory to a new directory named `configs/`, and modify the configuration files inside it as needed. This directory contains model and API-specific settings.
19+
Copy the `.env-example` file to `.env`, and fill in the required environment variables according to your environment and API keys.
2320

2421
## Setup MemOS
2522
### local server

evaluation/configs-example/mem_cube_config.json

Lines changed: 0 additions & 51 deletions
This file was deleted.

evaluation/configs-example/mos_memos_config.json

Lines changed: 0 additions & 51 deletions
This file was deleted.

src/memos/log.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ def close(self):
187187
},
188188
"handlers": {
189189
"console": {
190-
"level": "DEBUG",
190+
"level": selected_log_level,
191191
"class": "logging.StreamHandler",
192192
"stream": stdout,
193193
"formatter": "no_datetime",

0 commit comments

Comments
 (0)