Skip to content

Commit 615923a

Browse files
authored
docs: Fix typos, grammar, style (#106)
Signed-off-by: Karl Horky <karl.horky@gmail.com>
1 parent caf6563 commit 615923a

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

readme.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<a href="https://memobase.io">
33
<picture>
4-
<img alt="Shows the Memobase logo" src="./assets/images/logo.png" width="80%">
4+
<img alt="Memobase logo" src="./assets/images/logo.png" width="80%">
55
</picture>
66
</a>
77
<h1>Memobase</h1>
@@ -77,12 +77,12 @@ Memobase can provide you structured profiles of users, check out the [result](./
7777
"major": "국어국문학과 (Korean Language and Literature)"
7878
},
7979
"interest": {
80-
"games": 'User is interested in Cyberpunk 2077 and wants to create a game better than it',
81-
'youtube_channels': "Kurzgesagt",
80+
"games": "User is interested in Cyberpunk 2077 and wants to create a game better than it",
81+
"youtube_channels": "Kurzgesagt",
8282
...
8383
},
8484
"psychological": {...},
85-
'work': {'working_industry': ..., 'title': ..., },
85+
"work": {"working_industry": ..., "title": ..., },
8686
...
8787
}
8888
```
@@ -92,7 +92,7 @@ Memobase can provide you structured profiles of users, check out the [result](./
9292
## 🎉 Recent Updates
9393
- `0.0.38`: we updated the workflows in Memobase, reducing the insert cost by 30%
9494
- `0.0.37`: we added fine-grained event gist, enabling the detailed search on users' timeline. [Re-ran the LOCOMO benchmark](./docs/experiments/locomo-benchmark) and we're SOTA!
95-
- `0.0.36`: we updated the search of `context` api, make the search between 500~1000ms(depends on the embedding API you're using). Also, you can [pass prompt template](https://docs.memobase.io/api-reference/prompt/get_context#parameter-customize-context-prompt) to `context` api to pack memories directly into prompt.
95+
- `0.0.36`: we updated the search of `context` api, making the search take between 500~1000ms (depending on the embedding API you're using). Also, you can [pass a prompt template](https://docs.memobase.io/api-reference/prompt/get_context#parameter-customize-context-prompt) to the `context` api to pack memories directly into prompt.
9696

9797

9898

@@ -101,7 +101,7 @@ Memobase can provide you structured profiles of users, check out the [result](./
101101
- [Table of Contents](#table-of-contents)
102102
- [Core Features](#core-features)
103103
- [Get Started](#get-started)
104-
- [Step-by-step break down](#step-by-step-break-down)
104+
- [Step-by-step breakdown](#step-by-step-breakdown)
105105
- [1. Make sure you're connected](#1-make-sure-youre-connected)
106106
- [2. Manage Users](#2-manage-users)
107107
- [3. Insert Data](#3-insert-data)
@@ -126,13 +126,13 @@ Define and control exactly what user information your AI captures.
126126

127127
📈 **SOTA**
128128

129-
check out performance on [public benchmark](./docs/experiments/locomo-benchmark) against mem0, langmem, zep...
129+
Check out performance on [public benchmark](./docs/experiments/locomo-benchmark) against mem0, langmem, zep...
130130

131131
📅 **Time-aware Memory**
132132

133-
Memobase has more than user profiles, it also records [user event](https://docs.memobase.io/features/event/event). User event is essiential to answer time-related question, see how we can [improve temporal memory much better](./docs/experiments/locomo-benchmark/README.md#Result) than other memory solutions.
133+
Memobase has more than user profiles, it also records [user event](https://docs.memobase.io/features/event/event). User event is essential to answer time-related question, see how we can [improve temporal memory much better](./docs/experiments/locomo-benchmark/README.md#Result) than other memory solutions.
134134

135-
**🖼️ Contorllable Memory**
135+
**🖼️ Controllable Memory**
136136

137137
Among all types of memory, only some may enhance your product experience. Memobase offers a flexible configuration for you to [design the profile](https://docs.memobase.io/features/profile/profile).
138138

@@ -152,7 +152,7 @@ Memobase is building with FastAPI, Postgres and Redis, supporting request cachin
152152

153153
<div align="center">
154154
<picture>
155-
<img alt="Shows the Memobase Workflow" src="./assets/images/starter.png" width="80%">
155+
<img alt="Memobase Workflow" src="./assets/images/starter.png" width="80%">
156156
</picture>
157157
<p>How Memobase works?</p>
158158
</div>
@@ -184,7 +184,7 @@ https://github.com/user-attachments/assets/eb2eea30-48bc-4714-9706-e417ae1931df
184184

185185

186186

187-
## Step-by-step break down
187+
## Step-by-step breakdown
188188

189189
> [!TIP]
190190
>
@@ -219,7 +219,7 @@ print(u)
219219

220220
### 3. Insert Data
221221

222-
> In Memobase, all types of data are blobs to a user that can insert, get and delete:
222+
> In Memobase, all types of data are blobs for a user, which can be inserted, retrieved, and deleted:
223223
224224
```python
225225
messages = [
@@ -238,7 +238,7 @@ print(u.get(bid)) # not found once you flush the memory.
238238
# u.delete(bid)
239239
```
240240

241-
> Be default, Memobase will remove the blobs once they're processed. This means that apart from the relevant memory, your data will not be stored with Memobase. You can persist the blobs by adjusting the [configuration file](https://docs.memobase.io/features/customization/full#storage-config).
241+
> By default, Memobase will remove the blobs once they're processed. This means that apart from the relevant memory, your data will not be stored with Memobase. You can persist the blobs by adjusting the [configuration file](https://docs.memobase.io/features/customization/full#storage-config).
242242
243243
### 4. Get your Memory
244244

@@ -405,7 +405,7 @@ Join the community for support and discussions:
405405

406406
- [Follow us on Twitter](https://x.com/memobase_io) 𝕏
407407

408-
Or Just [email us](mailto:contact@memobase.io) ❤️
408+
Or just [email us](mailto:contact@memobase.io) ❤️
409409

410410

411411

0 commit comments

Comments
 (0)