Watch these videos to see Memory Lane in action:
-
Clone the repository to your local machine:
git clone https://github.com/Spiral-Memory/MemoryLane.git
-
Navigate to the project directory:
cd MemoryLane
-
Ensure Python 3.10.0 is installed to avoid dependency errors.
-
Create a virtual environment:
python3 -m venv .venv
-
Activate the virtual environment:
-
On Windows:
.venv\Scripts\activate
-
-
Install dependencies:
pip install -r requirements.txt
-
Download
intent_cf_model
, extract it, and place it in the root folder: Download intent_cf_model -
Download
vosk-model-small-en-in-0.4
for speech-to-text and place it in the root folder: Download vosk-model-small-en-in-0.4
To generate the intent_cf_model
manually:
cd dev_test/intent_train
python train.py
-
Create a
.env
file and add your MongoDB connection string:DB_URL=mongodb+srv://username:password@cluster_url/?retryWrites=true&w=majority&appName=appName
-
Head to
main.py
-
Run the main script:
python main.py
The script launches an Assistance Bot for user interaction.
-
Choose an action by entering the corresponding number:
- 1: Add a new relative
- 2: Start recognition
- 3: Exit the program
- Enter name, address, relationship, and gender
- Upload relative’s images
- The system generates facial embeddings and updates the detector
-
Choose between:
- Voice Mode (Option 1)
- Text Mode (Option 2)
The bot will assist accordingly.
- Select option 3 to exit gracefully
- On invalid input, you’ll see: "Invalid Choice"
- The bot will prompt you again
Just follow the terminal prompts, and the bot will walk you through everything smoothly.