diff --git a/docs/guides/memory.mdx b/docs/guides/memory.mdx index d5ee272fd..80eb0f054 100644 --- a/docs/guides/memory.mdx +++ b/docs/guides/memory.mdx @@ -7,9 +7,34 @@ icon: "brain" GAIA Agent Memory is a persistent knowledge system that gives your agent a **second brain**. It remembers facts, preferences, errors, and workflows across sessions -- so every conversation picks up where the last one left off. All data stays local on your machine in a single SQLite file. - **First time here?** Complete the [Setup](/setup) guide first, then come back to enable memory. + **First time here?** Complete the [Quickstart (For Developers)](/quickstart#for-developers) + or [Manual Install](/quickstart#manual-install) guide first, then come back to enable memory. +## Prerequisites + +Before using Agent Memory, make sure you have the following in place: + +- **Install path:** Developer install — clone the repo and install from source: + + ```bash + git clone https://github.com/amd/gaia.git + cd gaia + uv venv .venv --python 3.12 + source .venv/bin/activate # Windows: .venv\Scripts\activate + uv pip install -e ".[dev,rag]" + ``` + +- **Extras required:** `[dev,rag]` — `[rag]` provides the FAISS index used for memory recall; `[dev]` adds the developer toolchain + +- **Lemonade server** must be running before you start: + + ```bash + lemonade-server serve + ``` + +- **Example files** referenced in this guide are inside the cloned repo under `examples/` + Memory is currently integrated into the Chat Agent. Any agent built on the GAIA Agent base class can add memory via the `MemoryMixin` -- see the [Memory SDK Reference](/sdk/sdks/memory) for developer details.