memorychat / README.md
artecnosomatic's picture
Fix README format for Hugging Face Spaces configuration
8c83fc8
---
title: Memory Chat with Hugging Face
emoji: πŸ€–
colorFrom: blue
colorTo: gray
sdk: gradio
app_file: app.py
pinned: false
license: mit
---
# Hugging Face Memory Chat
A conversational AI application built with Hugging Face models that records and remembers user memories.
## Features
- πŸ€– Hugging Face model integration
- πŸ’Ύ Memory storage and retrieval
- πŸ’¬ Simple conversational interface
- πŸ” Secure memory management
## Setup
1. Install requirements:
```bash
pip install -r requirements.txt
```
2. Set up Hugging Face API token:
```bash
export HUGGINGFACE_API_TOKEN=your_token_here
```
3. Run the application:
```bash
python app.py
```
## Usage
The application provides a simple interface where you can:
- Have conversations with the AI
- The AI will automatically record important memories from your conversations
- Retrieve memories when relevant to the conversation
- View your memory timeline
## Project Structure
```
hf-memory-chat/
β”œβ”€β”€ app.py # Main application
β”œβ”€β”€ memory_manager.py # Memory storage and retrieval
β”œβ”€β”€ chat_interface.py # Conversational interface
β”œβ”€β”€ config.py # Configuration settings
β”œβ”€β”€ requirements.txt # Python dependencies
└── memories/ # Memory storage directory
β”œβ”€β”€ memories.json # Memory database
└── timeline.md # Human-readable memory timeline
```
## License
MIT License