You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(README): update documentation and improve readability
- Refactor README content for better structure and clarity
- Add installation instructions for both PyPI and source installations
- Clarify the relationship between this repository and the MemFuse server
- Update example code and add contextual follow-up example
- Improve documentation links and community support sections
Copy file name to clipboardExpand all lines: README.md
+33-44Lines changed: 33 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,52 +43,41 @@
43
43
44
44
## About MemFuse
45
45
46
-
Large-language-model apps are stateless out of the box.
47
-
Once the context window rolls over, yesterday's chat, the user's name, or that crucial fact vanishes.
46
+
Largelanguagemodel applications are inherently stateless by design.
47
+
When the context window reaches its limit, previous conversations, user preferences, and critical information simply disappear.
48
48
49
-
**MemFuse**plugs a persistent, query-able memory layer between your LLM and a storage backend so agents can:
49
+
**MemFuse**bridges this gap by providing a persistent, queryable memory layer between your LLM and storage backend, enabling AI agents to:
50
50
51
-
-remember user preferences across sessions
52
-
-recall facts & events thousands of turns later
53
-
-trim token spend instead of resending the whole chat history
54
-
-learn continuously and self-improve over time
51
+
-**Remember** user preferences and context across sessions
52
+
-**Recall** facts and events from thousands of interactions later
53
+
-**Optimize** token usage by avoiding redundant chat history resending
54
+
-**Learn** continuously and improve performance over time
55
55
56
-
This repository contains the Python SDK for interacting with a MemFuse server. For more information about the MemFuse server and its features, please visit the [main MemFuse repository](https://github.com/memfuse/memfuse).
56
+
This repository contains the official Python SDK for seamless integration with MemFuse servers. For comprehensive information about the MemFuse server architecture and advanced features, please visit the [MemFuse Server repository](https://github.com/memfuse/memfuse).
57
57
58
58
## Installation
59
59
60
-
First, ensure you have a MemFuse server running. To set up the MemFuse server locally:
60
+
> **Note:** This is the standalone Client SDK repository. If you need to install and run the MemFuse server, which is essential to use the SDK, please visit the [MemFuse Server repository](https://github.com/memfuse/memfuse).
61
61
62
-
1. Clone the [main MemFuse repository](https://github.com/memfuse/memfuse):
63
-
```bash
64
-
git clone https://github.com/memfuse/memfuse.git
65
-
cd memfuse
66
-
```
67
-
2. Once in the `memfuse` directory, install its dependencies and run the server using one of the following methods:
62
+
You can install the MemFuse Python SDK using one of the following methods:
# Example Output: Follow-up: Some challenges of living on Mars include its thin atmosphere, extreme temperatures, high radiation levels, and the lack of liquid water on the surface.
139
128
```
140
129
141
-
MemFuse will automatically manage recalling relevant information and storing new memories from the conversation within the specified `memory` scope.
130
+
MemFuse automatically manages the retrieval of relevant information and storage of new memories from conversations within the specified `memory` scope.
142
131
143
132
## Examples
144
133
145
-
You can find more detailed examples in the [examples/](examples/) directory of this repository, showcasing:
134
+
Explore comprehensive examples in the [examples/](examples/) directory of this repository, featuring:
146
135
147
-
- Basic and asynchronous operations
148
-
- Continued conversations
149
-
- Integrations with Gradiofor chatbots (including streaming)
136
+
-**Basic Operations:** Fundamental usage patterns and asynchronous operations
137
+
-**Conversation Continuity:** Maintaining context across multiple interactions
138
+
-**UI Integrations:**Gradio-based chatbot implementations with streaming support
150
139
151
140
## Documentation
152
141
153
-
- For detailed information about the MemFuse server, its architecture, and advanced configuration, please refer to the [main MemFuse documentation](https://memfuse.vercel.app/).
154
-
- SDK-specific documentation and API references will be added here soon.
142
+
-**Server Documentation:**For detailed information about the MemFuse serverarchitecture and advanced configuration, visit the [MemFuse online documentation](https://memfuse.vercel.app/)
143
+
-**SDK Documentation:** Comprehensive API references and guides will be available soon
155
144
156
145
## Community & Support
157
146
158
-
Join the MemFuse community:
147
+
Join our growing community:
159
148
160
-
- **GitHub Discussions:** For roadmap voting, RFCs, Q&A in the [main MemFuse repository](https://github.com/memfuse/memfuse).
149
+
-**GitHub Discussions:** Participate in roadmap discussions, RFCs, and Q&A in the [MemFuse Server repository](https://github.com/memfuse/memfuse)
150
+
-**Issues & Features:** Report bugs or request features in this repository's [Python SDK Issues section](https://github.com/memfuse/memfuse-python/issues)
161
151
162
-
If MemFuse is helpful to you, please ⭐ star the [main repo](https://github.com/memfuse/memfuse) and this SDK repo!
152
+
If MemFuse enhances your projects, please ⭐ star both the [server repository](https://github.com/memfuse/memfuse) and this SDK repository!
163
153
164
154
## License
165
155
166
-
This MemFuse Python SDK is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for more details.
167
-
(You'll need to add a LICENSE file to this SDK repository, typically a copy of the Apache 2.0 license text).
156
+
This MemFuse Python SDK is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for complete details.
0 commit comments