Spaces:
Running
Running
Anirudh Esthuri
commited on
Commit
Β·
93ab663
1
Parent(s):
3653027
Update README with brain emoji, better description, and token authentication instructions
Browse files
README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
| 1 |
---
|
| 2 |
title: MemMachine Playground
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: green
|
| 5 |
colorTo: purple
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
-
short_description:
|
| 9 |
app_port: 7860
|
| 10 |
hf_oauth: true
|
| 11 |
hf_oauth_scopes:
|
|
@@ -14,13 +14,114 @@ hf_oauth_authorized_org:
|
|
| 14 |
- Memverge
|
| 15 |
---
|
| 16 |
|
|
|
|
| 17 |
|
|
|
|
| 18 |
|
| 19 |
-
|
| 20 |
|
| 21 |
-
|
| 22 |
|
| 23 |
-
-
|
| 24 |
-
-
|
| 25 |
-
- Memory
|
| 26 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
title: MemMachine Playground
|
| 3 |
+
emoji: π§
|
| 4 |
colorFrom: green
|
| 5 |
colorTo: purple
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
+
short_description: Test and chat with leading LLMs with and without AI memory
|
| 9 |
app_port: 7860
|
| 10 |
hf_oauth: true
|
| 11 |
hf_oauth_scopes:
|
|
|
|
| 14 |
- Memverge
|
| 15 |
---
|
| 16 |
|
| 17 |
+
# π§ MemMachine Playground
|
| 18 |
|
| 19 |
+
**Test and chat with leading LLMs with and without AI memory**
|
| 20 |
|
| 21 |
+
A powerful playground for experimenting with various Large Language Models (LLMs) enhanced by MemMachine's persistent memory system. Compare conversations with and without memory to see how AI memory transforms your interactions.
|
| 22 |
|
| 23 |
+
## β¨ Features
|
| 24 |
|
| 25 |
+
- **Multiple LLM Providers**: OpenAI, Anthropic (Claude), AWS Bedrock, DeepSeek, and more
|
| 26 |
+
- **Persistent Memory**: AI remembers your conversations across sessions
|
| 27 |
+
- **Profile Memory**: Builds a personalized profile of you over time
|
| 28 |
+
- **Episodic Memory**: Remembers specific conversations and context
|
| 29 |
+
- **Secure Authentication**: Token-based authentication to protect your memories
|
| 30 |
+
- **Session Management**: Create and manage multiple conversation sessions
|
| 31 |
+
|
| 32 |
+
## π Getting Started
|
| 33 |
+
|
| 34 |
+
### Step 1: Create a Hugging Face Read Token
|
| 35 |
+
|
| 36 |
+
To authenticate and access your personalized memories, you'll need a Hugging Face access token:
|
| 37 |
+
|
| 38 |
+
1. **Go to Hugging Face Settings**
|
| 39 |
+
- Visit: https://huggingface.co/settings/tokens
|
| 40 |
+
- Or click your profile β Settings β Access Tokens
|
| 41 |
+
|
| 42 |
+
2. **Create a New Token**
|
| 43 |
+
- Click **"New token"** button
|
| 44 |
+
- **Name**: Enter a descriptive name (e.g., "MemMachine Playground")
|
| 45 |
+
- **Role**: Select **"Read"** (this is sufficient for authentication)
|
| 46 |
+
- Click **"Generate token"**
|
| 47 |
+
|
| 48 |
+
3. **Copy Your Token**
|
| 49 |
+
- β οΈ **Important**: Copy the token immediately (it starts with `hf_`)
|
| 50 |
+
- You won't be able to see it again after closing the page
|
| 51 |
+
- Store it securely
|
| 52 |
+
|
| 53 |
+
### Step 2: Authenticate in the App
|
| 54 |
+
|
| 55 |
+
1. **Open the Playground**
|
| 56 |
+
- The app will prompt you to authenticate on first use
|
| 57 |
+
|
| 58 |
+
2. **Enter Your Token**
|
| 59 |
+
- Paste your Hugging Face Read token in the authentication field
|
| 60 |
+
- Click **"Authenticate"**
|
| 61 |
+
- Your username will be automatically detected and locked
|
| 62 |
+
|
| 63 |
+
3. **Start Chatting**
|
| 64 |
+
- Your memories are now personalized to your account
|
| 65 |
+
- All conversations are stored securely under your username
|
| 66 |
+
|
| 67 |
+
## π‘ How to Use
|
| 68 |
+
|
| 69 |
+
### Basic Usage
|
| 70 |
+
|
| 71 |
+
1. **Choose a Model**
|
| 72 |
+
- Select from the dropdown in the sidebar
|
| 73 |
+
- Models include GPT-4, Claude, Bedrock, and more
|
| 74 |
+
|
| 75 |
+
2. **Start a Conversation**
|
| 76 |
+
- Type your message in the chat input
|
| 77 |
+
- The AI will respond using your memory context
|
| 78 |
+
|
| 79 |
+
3. **Compare with Memory**
|
| 80 |
+
- Toggle "Compare with Control persona" to see responses with/without memory
|
| 81 |
+
- See how memory enhances the AI's understanding
|
| 82 |
+
|
| 83 |
+
### Advanced Features
|
| 84 |
+
|
| 85 |
+
- **Multiple Sessions**: Create different conversation sessions for different topics
|
| 86 |
+
- **Persona Selection**: Test with different user personas (Charlie, Jing, Charles, Control)
|
| 87 |
+
- **Profile Management**: View and delete your AI profile when needed
|
| 88 |
+
- **Memory Search**: The AI searches your past conversations for relevant context
|
| 89 |
+
|
| 90 |
+
## π Security & Privacy
|
| 91 |
+
|
| 92 |
+
- **Token Authentication**: Your Hugging Face token is used only to identify your username
|
| 93 |
+
- **Session-Only Storage**: Tokens are stored only in your browser session
|
| 94 |
+
- **Isolated Memories**: Each user's memories are completely isolated
|
| 95 |
+
- **No Token Sharing**: Your token is never shared or stored permanently
|
| 96 |
+
|
| 97 |
+
## ποΈ Architecture
|
| 98 |
+
|
| 99 |
+
- **Frontend**: Streamlit (runs in this Hugging Face Space)
|
| 100 |
+
- **Backend**: MemMachine server running on EC2
|
| 101 |
+
- **Memory Storage**: Neo4j (graph) + Postgres (vector search)
|
| 102 |
+
- **Authentication**: Hugging Face token-based authentication
|
| 103 |
+
|
| 104 |
+
## π Notes
|
| 105 |
+
|
| 106 |
+
- **Token Expiration**: Read tokens don't expire automatically - they remain valid until you revoke them
|
| 107 |
+
- **Memory Persistence**: Your memories are tied to your username, not your token. You can create new tokens without losing memories
|
| 108 |
+
- **Rate Limiting**: The backend implements rate limiting (50 requests/minute) to prevent abuse
|
| 109 |
+
|
| 110 |
+
## π Troubleshooting
|
| 111 |
+
|
| 112 |
+
**"Invalid token" error?**
|
| 113 |
+
- Make sure you copied the entire token (including `hf_` prefix)
|
| 114 |
+
- Verify the token has "Read" permissions
|
| 115 |
+
- Try creating a new token if the issue persists
|
| 116 |
+
|
| 117 |
+
**Can't see my memories?**
|
| 118 |
+
- Ensure you're authenticated with the same username
|
| 119 |
+
- Memories are stored per username, not per token
|
| 120 |
+
|
| 121 |
+
**Need help?**
|
| 122 |
+
- Check that your token has Read permissions
|
| 123 |
+
- Verify you're using a valid Hugging Face account
|
| 124 |
+
|
| 125 |
+
---
|
| 126 |
+
|
| 127 |
+
**Powered by [MemMachine](https://github.com/memverge/memmachine)** π§
|