Skip to content

Commit b8c4a76

Browse files
committed
docs: clarify optional dependencies
1 parent 91c7695 commit b8c4a76

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,21 +147,31 @@ For more detailed examples, please check out the [`examples`](./examples) direct
147147
pip install MemoryOS
148148
```
149149

150-
### Development Install
150+
### Optional Dependencies
151+
152+
MemOS provides several optional dependency groups for different features. You can install them based on your needs.
153+
154+
| Feature | Package Name |
155+
| --------------------- | ------------------------- |
156+
| Tree Memory | `MemoryOS[tree-mem]` |
157+
| Memory Reader | `MemoryOS[mem-reader]` |
158+
| Memory Scheduler | `MemoryOS[mem-scheduler]` |
151159

152-
To contribute to MemOS, clone the repository and install it in editable mode:
160+
Example installation commands:
153161

154162
```bash
155-
git clone https://github.com/MemTensor/MemOS.git
156-
cd MemOS
157-
make install
163+
pip install MemoryOS[tree-mem]
164+
pip install MemoryOS[tree-mem,mem-reader]
165+
pip install MemoryOS[mem-scheduler]
166+
pip install MemoryOS[tree-mem,mem-reader,mem-scheduler]
158167
```
159168

160-
### Optional Dependencies
169+
### External Dependencies
161170

162171
#### Ollama Support
163172

164173
To use MemOS with [Ollama](https://ollama.com/), first install the Ollama CLI:
174+
165175
```bash
166176
curl -fsSL https://ollama.com/install.sh | sh
167177
```

0 commit comments

Comments
 (0)