Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ekuka86 committed Jul 11, 2024
1 parent 025f7c8 commit 8cc3c2d
Showing 1 changed file with 12 additions and 19 deletions.
31 changes: 12 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
# Open-Memory

## Setup Guide
* Clone the repository (data-max-hq/open-memory)
* cd into /open-memory
* pip install pyautogui
* In the terminal run ‘make build’
* In the terminal run ‘make run’
* After a couple of minutes then head over to "localhost:8080"
* In "ADD LLM" type out the LLM you want to use (we recomend qwen2:1.5b or qwen2:0.5b) and press "Add LLM"

## Usage Flow:

The user runs ‘screenshot-desktop.py’ whenever they want to start recording their screens
Expand All @@ -28,6 +17,18 @@ The retrieved information is presented to the user, providing them with the nece

This approach ensures that all data processing and storage remain under the user's control, eliminating the risks associated with cloud-based solutions and empowering users to maintain their privacy.


# Open-Memory

## Setup Guide
* Clone the repository (data-max-hq/open-memory)
* cd into /open-memory
* pip install pyautogui
* In the terminal run ‘make build’
* In the terminal run ‘make run’
* After a couple of minutes then head over to "localhost:8080"
* In "ADD LLM" type out the LLM you want to use (we recomend qwen2:1.5b or qwen2:0.5b) and press "Add LLM"



## Functionality
Expand All @@ -38,11 +39,3 @@ Query ChromaDB: Test the database to retrieve relevant pieces of context for a s


LLM Prompt: Pass a query to QWEN2:1.5b to get an explanation of what the user was doing based on the retrieved context.


## Summary


In summary, our open-source alternative to Windows Recall offers a secure, private, and efficient way to continuously record screens and perform OCR, ensuring that all data remains under the user's control. By leveraging the high-quality embedding and reranking models from JinaAI, we enhance the accuracy and relevance of the information retrieved, providing users with a powerful and privacy-conscious solution. This project demonstrates the potential of open-source tools to address privacy concerns while delivering robust functionality.


0 comments on commit 8cc3c2d

Please sign in to comment.