docs: rewrite README — raw data → memory → agent#426
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR rewrites README.md to reposition memU around the workflow “raw workspace ingestion → structured memory → agent-ready retrieval,” targeting agent developers and small B2B teams.
Changes:
- Reframes the product narrative and reorganizes sections around an explicit “How it works” pipeline.
- Updates use cases and example workflows to emphasize agent integration and token-cost reduction.
- Refreshes API/quick-start snippets and trims contribution/setup guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+177
to
+181
| # Ingest customer workspace: emails, tickets, chat history | ||
| await service.memorize(resource_url="customer_workspace/", modality="conversation", user={"user_id": "acme-corp"}) | ||
|
|
||
| # Agent retrieves full customer context before responding | ||
| context = await service.retrieve(queries=[{"role": "user", "content": {"text": "What does this customer need?"}}], where={"user_id": "acme-corp"}) |
Comment on lines
+329
to
+331
| resource_url="path/to/file.json", # file path, URL, or directory | ||
| modality="conversation", # conversation | document | image | video | audio | ||
| user={"user_id": "123"} # optional: scope to a user or agent |
Comment on lines
348
to
352
| result = await service.retrieve( | ||
| queries=[ | ||
| {"role": "user", "content": {"text": "What are their preferences?"}}, | ||
| {"role": "user", "content": {"text": "Tell me about work habits"}} | ||
| ], | ||
| where={"user_id": "123"}, # Optional: scope filter | ||
| method="rag" # or "llm" for deeper reasoning | ||
| queries=[{"role": "user", "content": {"text": "What are their preferences?"}}], | ||
| where={"user_id": "123"}, # scope filter | ||
| method="rag" # "rag" (fast) or "llm" (deep reasoning) | ||
| ) |
Comment on lines
+262
to
+270
| docker run -d --name memu-postgres \ | ||
| -e POSTGRES_USER=postgres \ | ||
| -e POSTGRES_PASSWORD=postgres \ | ||
| -e POSTGRES_PASSWORD=your_password \ | ||
| -e POSTGRES_DB=memu \ | ||
| -p 5432:5432 \ | ||
| pgvector/pgvector:pg16 | ||
|
|
||
| # Run continuous learning test | ||
| export OPENAI_API_KEY=your_api_key | ||
| cd tests | ||
| python test_postgres.py | ||
| export OPENAI_API_KEY=your_key | ||
| cd tests && python test_postgres.py |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites README to focus on the core value proposition: raw workspace ingestion → structured memory → agent-ready retrieval. Target audience: agent developers and small B2B teams.