150 lines
7.4 KiB
Markdown
150 lines
7.4 KiB
Markdown
# PromethAI-Memory
|
|
Memory management and testing for the AI Applications and RAGs
|
|
|
|
Dynamic Graph Memory Manager + DB + Rag Test Manager
|
|
|
|
|
|
<p align="center">
|
|
<a href="https://prometh.ai//#gh-light-mode-only">
|
|
<img src="assets/topoteretes_logo.png" width="10%" alt="promethAI logo" />
|
|
</a>
|
|
|
|
|
|
</p>
|
|
|
|
<p align="center"><i>Open-source framework that manages memory for AI Agents and LLM apps </i></p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/topoteretes/PromethAI-Memory/fork" target="blank">
|
|
<img src="https://img.shields.io/github/forks/topoteretes/PromethAI-Memory?style=for-the-badge" alt="promethAI forks"/>
|
|
</a>
|
|
|
|
<a href="https://github.com/topoteretes/PromethAI-Backend/stargazers" target="blank">
|
|
<img src="https://img.shields.io/github/stars/topoteretes/PromethAI-Memory?style=for-the-badge" alt="promethAI stars"/>
|
|
</a>
|
|
<a href="https://github.com/topoteretes/PromethAI-Backend/pulls" target="blank">
|
|
<img src="https://img.shields.io/github/issues-pr/topoteretes/PromethAI-Memory?style=for-the-badge" alt="promethAI pull-requests"/>
|
|
</a>
|
|
<a href='https://github.com/topoteretes/PromethAI-Backend/releases'>
|
|
<img src='https://img.shields.io/github/release/topoteretes/PromethAI-Memory?&label=Latest&style=for-the-badge'>
|
|
</a>
|
|
|
|
</p>
|
|
|
|
[//]: # (<p align="center"><b>Follow PromethAI </b></p>)
|
|
|
|
[//]: # (<p align="center">)
|
|
|
|
[//]: # (<a href="https://twitter.com/_promethAI" target="blank">)
|
|
|
|
[//]: # (<img src="https://img.shields.io/twitter/follow/_promethAI?label=Follow: _promethAI&style=social" alt="Follow _promethAI"/>)
|
|
|
|
[//]: # (</a>)
|
|
|
|
[//]: # (<p align="center">)
|
|
|
|
[//]: # (<a href="https://prometh.ai" target="_blank"><img src="https://img.shields.io/twitter/url?label=promethAI Website&logo=website&style=social&url=https://github.com/topoteretes/PromethAI-Memory"/></a>)
|
|
|
|
[//]: # (<p align="center">)
|
|
|
|
[//]: # (<a href="https://www.youtube.com/@_promethAI" target="_blank"><img src="https://img.shields.io/twitter/url?label=Youtube&logo=youtube&style=social&url=https://github.com/topoteretes/PromethAI-Memory"/></a>)
|
|
|
|
[//]: # (</p>)
|
|
|
|
|
|
<p align="center"><b>Share promethAI Repository</b></p>
|
|
|
|
<p align="center">
|
|
|
|
<a href="https://twitter.com/intent/tweet?text=Check%20this%20GitHub%20repository%20out.%20promethAI%20-%20Let%27s%20you%20easily%20build,%20manage%20and%20run%20useful%20autonomous%20AI%20agents.&url=https://github.com/topoteretes/PromethAI-Backend-Backend&hashtags=promethAI,AGI,Autonomics,future" target="blank">
|
|
<img src="https://img.shields.io/twitter/follow/_promethAI?label=Share Repo on Twitter&style=social" alt="Follow _promethAI"/></a>
|
|
<a href="https://t.me/share/url?text=Check%20this%20GitHub%20repository%20out.%20promethAI%20-%20Let%27s%20you%20easily%20build,%20manage%20and%20run%20useful%20autonomous%20AI%20agents.&url=https://github.com/topoteretes/PromethAI-Backend" target="_blank"><img src="https://img.shields.io/twitter/url?label=Telegram&logo=Telegram&style=social&url=https://github.com/topoteretes/PromethAI-Backend" alt="Share on Telegram"/></a>
|
|
<a href="https://api.whatsapp.com/send?text=Check%20this%20GitHub%20repository%20out.%20promethAI%20-%20Let's%20you%20easily%20build,%20manage%20and%20run%20useful%20autonomous%20AI%20agents.%20https://github.com/topoteretes/PromethAI-Backend"><img src="https://img.shields.io/twitter/url?label=whatsapp&logo=whatsapp&style=social&url=https://github.com/topoteretes/PromethAI-Backend" /></a> <a href="https://www.reddit.com/submit?url=https://github.com/topoteretes/PromethAI-Backend&title=Check%20this%20GitHub%20repository%20out.%20promethAI%20-%20Let's%20you%20easily%20build,%20manage%20and%20run%20useful%20autonomous%20AI%20agents.
|
|
" target="blank">
|
|
<img src="https://img.shields.io/twitter/url?label=Reddit&logo=Reddit&style=social&url=https://github.com/topoteretes/PromethAI-Backend" alt="Share on Reddit"/>
|
|
</a> <a href="mailto:?subject=Check%20this%20GitHub%20repository%20out.&body=promethAI%20-%20Let%27s%20you%20easily%20build,%20manage%20and%20run%20useful%20autonomous%20AI%20agents.%3A%0Ahttps://github.com/topoteretes/PromethAI-Backend" target="_blank"><img src="https://img.shields.io/twitter/url?label=Gmail&logo=Gmail&style=social&url=https://github.com/topoteretes/PromethAI-Backend"/></a> <a href="https://www.buymeacoffee.com/promethAI" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="23" width="100" style="border-radius:1px"></a>
|
|
|
|
</p>
|
|
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Production-ready modern data platform
|
|
|
|
|
|
Browsing the database of theresanaiforthat.com, we can observe around [7000 new, mostly semi-finished projects](https://theresanaiforthat.com/) in the field of applied AI.
|
|
It seems it has never been easier to create a startup, build an app, and go to market… and fail.
|
|
|
|
Decades of technological advancements have led to small teams being able to do in 2023 what in 2015 required a team of dozens.
|
|
Yet, the AI apps currently being pushed out still mostly feel and perform like demos.
|
|
The rise of this new profession is perhaps signaling the need for a solution that is not yet there — a solution that in its essence represents a Large Language Model (LLM) — [a powerful general problem solver](https://lilianweng.github.io/posts/2023-06-23-agent/?fbclid=IwAR1p0W-Mg_4WtjOCeE8E6s7pJZlTDCDLmcXqHYVIrEVisz_D_S8LfN6Vv20) — available in the palm of your hand 24/7/365.
|
|
|
|
To address this issue, [dlthub](https://dlthub.com/) and [prometh.ai](http://prometh.ai/) will collaborate on a productionizing a common use-case, progressing step by step. We will utilize the LLMs, frameworks, and services, refining the code until we attain a clearer understanding of what a modern LLM architecture stack might entail.
|
|
|
|
## Read more on our blog post [prometh.ai](http://prometh.ai/promethai-memory-blog-post-on)
|
|
|
|
|
|
## Project Structure
|
|
|
|
### Level 1 - OpenAI functions + Pydantic + DLTHub
|
|
Scope: Give PDFs to the model and get the output in a structured format
|
|
We introduce the following concepts:
|
|
- Structured output with Pydantic
|
|
- CMD script to process custom PDFs
|
|
### Level 2 - Memory Manager + Metadata management
|
|
Scope: Give PDFs to the model and consolidate with the previous user activity and more
|
|
We introduce the following concepts:
|
|
|
|
- Long Term Memory -> store and format the data
|
|
- Episodic Buffer -> isolate the working memory
|
|
- Attention Modulators -> improve semantic search
|
|
- Docker
|
|
- API
|
|
|
|
### Level 3 - Dynamic Graph Memory Manager + DB + Rag Test Manager
|
|
Scope: Store the data in N-related stores and test the retrieval with the Rag Test Manager
|
|
- Dynamic Memory Manager -> store the data in N hierarchical stores
|
|
- Auto-generation of tests
|
|
- Multiple file formats supported
|
|
- Postgres DB to store metadata
|
|
- Docker
|
|
- API
|
|
|
|
|
|
## Run the level 3
|
|
|
|
Make sure you have Docker, Poetry, and Python 3.11 installed and postgres installed.
|
|
|
|
Copy the .env.example to .env and fill the variables
|
|
|
|
|
|
Start the docker:
|
|
|
|
```docker compose up promethai_mem ```
|
|
|
|
Use the poetry environment:
|
|
|
|
``` poetry shell ```
|
|
|
|
Make sure to run to initialize DB tables
|
|
|
|
``` python scripts/create_database.py ```
|
|
|
|
After that, you can run the RAG test manager.
|
|
|
|
|
|
```
|
|
python rag_test_manager.py \
|
|
--url "https://www.ibiblio.org/ebooks/London/Call%20of%20Wild.pdf" \
|
|
--test_set "example_data/test_set.json" \
|
|
--user_id "666" \
|
|
--metadata "example_data/metadata.json"
|
|
|
|
```
|
|
|
|
Examples of metadata structure and test set are in the folder "example_data"
|