Documentation
⭐ Star MemGPT on GitHub

MemGPT + open models

Set up MemGPT to run with open LLMs

📘

Need help?

Visit our Discord server and post in the #support channel. Make sure to check the local LLM troubleshooting page to see common issues before raising a new issue or posting on Discord.

📘

Using Windows?

If you're using Windows and are trying to get MemGPT with local LLMs setup, we recommend using Anaconda Shell, or WSL (for more advanced users). See more Windows installation tips here.

⚠️

MemGPT + open LLM failure cases

When using open LLMs with MemGPT, the main failure case will be your LLM outputting a string that cannot be understood by MemGPT. MemGPT uses function calling to manage memory (eg edit_core_memory(...) and interact with the user (send_message(...)), so your LLM needs generate outputs that can be parsed into MemGPT function calls. See the local LLM troubleshooting page for more information.

Installing dependencies

To install dependencies required for running local models, run:

pip install 'pymemgpt[local]'

If you installed from source (git clone then pip install -e .), do:

pip install -e '.[local]'

If you installed from source using Poetry, do:

poetry install -E local

Quick overview

  1. Put your own LLM behind a web server API (e.g. oobabooga web UI)
  2. Run memgpt configure and when prompted select your backend/endpoint type and endpoint address (a default will be provided but you may have to override it)

For example, if we are running web UI (which defaults to port 5000) on the same computer as MemGPT, running memgpt configure would look like this:

? Select LLM inference provider: local
? Select LLM backend (select 'openai' if you have an OpenAI compatible proxy): webui
? Enter default endpoint: http://localhost:5000
? Select default model wrapper (recommended: airoboros-l2-70b-2.1): airoboros-l2-70b-2.1
? Select your model's context window (for Mistral 7B models, this is probably 8k / 8192): 8192
? Select embedding provider: local
? Select default preset: memgpt_chat
? Select default persona: sam_pov
? Select default human: cs_phd
? Select storage backend for archival data: local
Saving config to /home/user/.memgpt/config

Now when we do memgpt run, it will use the LLM running on the local web server.

If you want to change the local LLM settings of an existing agent, you can pass flags to memgpt run:

# --model-wrapper will override the wrapper
# --model-endpoint will override the endpoint address
# --model-endpoint-type will override the backend type

# if we were previously using "agent_11" with web UI, and now want to use lmstudio, we can do:
memgpt run --agent agent_11 --model-endpoint http://localhost:1234 --model-endpoint-type lmstudio

Selecting a model wrapper

When you use local LLMs, you can specify a model wrapper that changes how the LLM input text is formatted before it is passed to your LLM.

You can change the wrapper used with the --model-wrapper flag:

memgpt run --model-wrapper airoboros-l2-70b-2.1

You can see the full selection of model wrappers by running memgpt configure:

? Select LLM inference provider: local
? Select LLM backend (select 'openai' if you have an OpenAI compatible proxy): webui
? Enter default endpoint: http://localhost:5000
? Select default model wrapper (recommended: airoboros-l2-70b-2.1): (Use arrow keys)
 » airoboros-l2-70b-2.1
   airoboros-l2-70b-2.1-grammar
   dolphin-2.1-mistral-7b
   dolphin-2.1-mistral-7b-grammar
   zephyr-7B
   zephyr-7B-grammar

Note: the wrapper name does not have to match the model name. For example, the dolphin-2.1-mistral-7b model works better with the airoboros-l2-70b-2.1 wrapper than the dolphin-2.1-mistral-7b wrapper. The model you load inside your LLM backend (e.g. LM Studio) determines what model is actually run, the --model-wrapper flag just determines how the prompt is formatted before it is passed to the LLM backend.

Grammars

Grammar-based sampling can help improve the performance of MemGPT when using local LLMs. Grammar-based sampling works by restricting the outputs of an LLM to a "grammar", for example, the MemGPT JSON function call grammar. Without grammar-based sampling, it is common to encounter JSON-related errors when using local LLMs with MemGPT.

To use grammar-based sampling, make sure you're using a backend that supports it: webui, llama.cpp, or koboldcpp, then you should specify one of the new wrappers that implements grammars, eg: airoboros-l2-70b-2.1-grammar.

Note that even though grammar-based sampling can reduce the mistakes your LLM makes, it can also make your model inference significantly slower.

Supported backends

Currently, MemGPT supports the following backends:

  • oobabooga web UI (Mac, Windows, Linux) (✔️ supports grammars)
  • LM Studio (Mac, Windows) (❌ does not support grammars)
  • koboldcpp (Mac, Windows, Linux) (✔️ supports grammars)
  • llama.cpp (Mac, Windows, Linux) (✔️ supports grammars)
  • vllm (Mac, Windows, Linux) (❌ does not support grammars)

If you would like us to support a new backend, feel free to open an issue or pull request on the MemGPT GitHub page!

Which model should I use?

📘

Recommended LLMs / models

To see a list of recommended LLMs to use with MemGPT, visit our Discord server and check the #model-chat channel.

If you are experimenting with MemGPT and local LLMs for the first time, we recommend you try the Dolphin Mistral finetune (e.g. ehartford/dolphin-2.2.1-mistral-7b or a quantized variant such as dolphin-2.2.1-mistral-7b.Q6_K.gguf), and use the default airoboros wrapper.

Generating MemGPT-compatible outputs is a harder task for an LLM than regular text output. For this reason we strongly advise users to NOT use models below Q5 quantization - as the model gets worse, the number of errors you will encounter while using MemGPT will dramatically increase (MemGPT will not send messages properly, edit memory properly, etc.).

Updated 2 months ago