Skip to content

Commit fc70e9f

Browse files
zZhangSirglin93
andauthored
Dev zhq new (#776)
* fix: update README.md * fix: update README.md --------- Co-authored-by: Zehao Lin <[email protected]>
1 parent 374c80c commit fc70e9f

File tree

1 file changed

+51
-49
lines changed

1 file changed

+51
-49
lines changed

README.md

Lines changed: 51 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,57 @@ showcasing its capabilities in **information extraction**, **temporal and cross-
117117
- **Parametric Memory**: Stores model adaptation parameters (e.g., LoRA weights).
118118
- **🔌 Extensible**: Easily extend and customize memory modules, data sources, and LLM integrations.
119119

120+
121+
## 📦 Installation
122+
123+
### Install via pip
124+
125+
```bash
126+
pip install MemoryOS
127+
```
128+
129+
### Optional Dependencies
130+
131+
MemOS provides several optional dependency groups for different features. You can install them based on your needs.
132+
133+
| Feature | Package Name |
134+
| --------------------- | ------------------------- |
135+
| Tree Memory | `MemoryOS[tree-mem]` |
136+
| Memory Reader | `MemoryOS[mem-reader]` |
137+
| Memory Scheduler | `MemoryOS[mem-scheduler]` |
138+
139+
Example installation commands:
140+
141+
```bash
142+
pip install MemoryOS[tree-mem]
143+
pip install MemoryOS[tree-mem,mem-reader]
144+
pip install MemoryOS[mem-scheduler]
145+
pip install MemoryOS[tree-mem,mem-reader,mem-scheduler]
146+
```
147+
148+
### External Dependencies
149+
150+
#### Ollama Support
151+
152+
To use MemOS with [Ollama](https://ollama.com/), first install the Ollama CLI:
153+
154+
```bash
155+
curl -fsSL https://ollama.com/install.sh | sh
156+
```
157+
158+
#### Transformers Support
159+
160+
To use functionalities based on the `transformers` library, ensure you have [PyTorch](https://pytorch.org/get-started/locally/) installed (CUDA version recommended for GPU acceleration).
161+
162+
#### Download Examples
163+
164+
To download example code, data and configurations, run the following command:
165+
166+
```bash
167+
memos download_examples
168+
```
169+
170+
120171
## 🚀 Getting Started
121172

122173
### ⭐️ MemOS online API
@@ -237,55 +288,6 @@ res = client.create_knowledgebase(
237288
print(f"result: {res}")
238289
```
239290

240-
## 📦 Installation
241-
242-
### Install via pip
243-
244-
```bash
245-
pip install MemoryOS
246-
```
247-
248-
### Optional Dependencies
249-
250-
MemOS provides several optional dependency groups for different features. You can install them based on your needs.
251-
252-
| Feature | Package Name |
253-
| --------------------- | ------------------------- |
254-
| Tree Memory | `MemoryOS[tree-mem]` |
255-
| Memory Reader | `MemoryOS[mem-reader]` |
256-
| Memory Scheduler | `MemoryOS[mem-scheduler]` |
257-
258-
Example installation commands:
259-
260-
```bash
261-
pip install MemoryOS[tree-mem]
262-
pip install MemoryOS[tree-mem,mem-reader]
263-
pip install MemoryOS[mem-scheduler]
264-
pip install MemoryOS[tree-mem,mem-reader,mem-scheduler]
265-
```
266-
267-
### External Dependencies
268-
269-
#### Ollama Support
270-
271-
To use MemOS with [Ollama](https://ollama.com/), first install the Ollama CLI:
272-
273-
```bash
274-
curl -fsSL https://ollama.com/install.sh | sh
275-
```
276-
277-
#### Transformers Support
278-
279-
To use functionalities based on the `transformers` library, ensure you have [PyTorch](https://pytorch.org/get-started/locally/) installed (CUDA version recommended for GPU acceleration).
280-
281-
#### Download Examples
282-
283-
To download example code, data and configurations, run the following command:
284-
285-
```bash
286-
memos download_examples
287-
```
288-
289291
## 💬 Community & Support
290292

291293
Join our community to ask questions, share your projects, and connect with other developers.

0 commit comments

Comments
 (0)