Teaching LLMs memory management for unbounded context 📚🦙
Go to file
Charles Packer 82fe642957
Update README.md
2023-12-02 13:17:22 -08:00
.github Removing dead code + legacy commands (#536) 2023-11-30 13:37:11 -08:00
db Dockerfile for running postgres locally (#393) 2023-11-09 14:26:53 -08:00
docs Add docs file for customizing embedding mode (#554) 2023-12-01 16:31:27 -08:00
memgpt fix cannot import name 'EmptyIndex' from 'llama_index' (#558) 2023-12-01 18:09:29 -08:00
tests Removing dead code + legacy commands (#536) 2023-11-30 13:37:11 -08:00
.gitignore cli improvements using questionary 2023-10-22 22:31:45 -07:00
.pre-commit-config.yaml softpass test when keys are missing (#369) 2023-11-09 12:11:19 -08:00
.readthedocs.yaml Create docs pages (#328) 2023-11-06 12:38:49 -08:00
CONTRIBUTING.md Removing dead code + legacy commands (#536) 2023-11-30 13:37:11 -08:00
LICENSE Create LICENSE 2023-10-16 11:40:34 -07:00
README.md Update README.md 2023-12-02 13:17:22 -08:00
main.py Removing dead code + legacy commands (#536) 2023-11-30 13:37:11 -08:00
mkdocs.yml Add documentation for using Hugging Face models for embeddings (#549) 2023-12-01 14:36:07 -08:00
poetry.lock Upgrade to `llama_index=0.9.10` (#556) 2023-12-01 17:45:25 -08:00
pyproject.toml Upgrade to `llama_index=0.9.10` (#556) 2023-12-01 17:45:25 -08:00


MemGPT logo


Try out our MemGPT chatbot on Discord!

NEW: You can now run MemGPT with open/local LLMs and AutoGen!

Discord arxiv 2310.08560 Documentation

🤖 Create perpetual chatbots with self-editing memory!

MemGPT demo video

🗃️ Chat with your data - talk to your local files or SQL database!

MemGPT demo video for sql search

Quick setup

Join Discord and message the MemGPT bot (in the #memgpt channel). Then run the following commands (messaged to "MemGPT Bot"):

  • /profile (to create your profile)
  • /key (to enter your OpenAI key)
  • /create (to create a MemGPT chatbot)

Make sure your privacy settings on this server are open so that MemGPT Bot can DM you:
MemGPT → Privacy Settings → Direct Messages set to ON

set DMs settings on MemGPT server to be open in MemGPT so that MemGPT Bot can message you

You can see the full list of available commands when you enter / into the message box.

MemGPT Bot slash commands

What is MemGPT?

Memory-GPT (or MemGPT in short) is a system that intelligently manages different memory tiers in LLMs in order to effectively provide extended context within the LLM's limited context window. For example, MemGPT knows when to push critical information to a vector database and when to retrieve it later in the chat, enabling perpetual conversations. Learn more about MemGPT in our paper.

Running MemGPT locally

Install MemGPT:

pip install pymemgpt

Add your OpenAI API key to your environment:

export OPENAI_API_KEY=YOUR_API_KEY # on Linux/Mac
$Env:OPENAI_API_KEY = "YOUR_API_KEY" # on Windows (PowerShell)

Configure default setting for MemGPT by running:

memgpt configure

Now, you can run MemGPT with:

memgpt run

You can run the following commands in the MemGPT CLI prompt:

  • /exit: Exit the CLI
  • /attach: Attach a loaded data source to the agent
  • /save: Save a checkpoint of the current agent/conversation state
  • /dump: View the current message log (see the contents of main context)
  • /dump <count>: View the last messages (all if is omitted)
  • /memory: Print the current contents of agent memory
  • /pop: Undo the last message in the conversation
  • /pop <count>: Undo the last messages in the conversation. It defaults to 3, which usually is one turn around in the conversation
  • /retry: Pops the last answer and tries to get another one
  • /rethink <text>: Will replace the inner dialog of the last assistant message with the to help shaping the conversation
  • /rewrite: Will replace the last assistant answer with the given text to correct or force the answer
  • /heartbeat: Send a heartbeat system message to the agent
  • /memorywarning: Send a memory warning system message to the agent

Once you exit the CLI with /exit, you can resume chatting with the same agent by specifying the agent name in memgpt run --agent <NAME>.


See full documentation at: https://memgpt.readthedocs.io/

Installing from source

To install MemGPT from source, start by cloning the repo:

git clone git@github.com:cpacker/MemGPT.git

Then navigate to the main MemGPT directory, and do:

pip install -e .

Now, you should be able to run memgpt from the command-line using the downloaded source code.

If you are having dependency issues using pip install -e ., we recommend you install the package using Poetry (see below). Installing MemGPT from source using Poetry will ensure that you are using exact package versions that have been tested for the production build.

Installing from source (using Poetry)

First, install Poetry using the official instructions here.

Then, you can install MemGPT from source with:

git clone git@github.com:cpacker/MemGPT.git
poetry shell
poetry install


For issues and feature requests, please open a GitHub issue or message us on our #support channel on Discord


Datasets used in our paper can be downloaded at Hugging Face.

🚀 Project Roadmap

  • Release MemGPT Discord bot demo (perpetual chatbot)
  • Add additional workflows (load SQL/text into MemGPT external context)
  • Integration tests
  • Integrate with AutoGen (discussion)
  • Add official gpt-3.5-turbo support (discussion)
  • CLI UI improvements (issue)
  • Add support for other LLM backends (issue, discussion)
  • Release MemGPT family of open models (eg finetuned Mistral) (discussion)