This release is a pre-release and may not be stable for production use.
MemGPT
🤖 Create perpetual chatbots with self-editing memory!
🗃️ Chat with your data - talk to your local files or SQL database!
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
You can see the full list of available commands when you enter / into the message box.
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
set OPENAI_API_KEY=YOUR_API_KEY # on Windows
$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/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>.
Documentation
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
Support
For issues and feature requests, please open a GitHub issue or message us on our #support channel on Discord
Datasets
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)
Release files for pymemgpt-nightly 0.1.18.dev20231110
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pymemgpt_nightly-0.1.18.dev20231110.tar.gz | 102.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pymemgpt_nightly-0.1.18.dev20231110-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 241.7 kB
Release files / pymemgpt_nightly-0.1.18.dev20231110.tar.gz
| Download URL | pymemgpt_nightly-0.1.18.dev20231110.tar.gz |
|---|---|
| Size | 102.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
797d0849d8ae0ba08783fdbaa3b77da3988da3668083761ec70141610f1fc319
|
|
BLAKE2b-256 checksum How to use checksums |
e0a552406e591813cdc523344e3557dff7634d3d60063f26ec0e85ebd94ba21c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.0 CPython/3.9.18 Linux/6.2.0-1015-azure
|
Release files / pymemgpt_nightly-0.1.18.dev20231110-py3-none-any.whl
| Download URL | pymemgpt_nightly-0.1.18.dev20231110-py3-none-any.whl |
|---|---|
| Size | 139.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cbdbbb754d5dc4610f2258f6a98cc80eda9bc993c06b45beff7ae5cce46ab01f
|
|
BLAKE2b-256 checksum How to use checksums |
8079d026f2e386023eef8d37314209af8b421c116247384c5955548c376803cb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.0 CPython/3.9.18 Linux/6.2.0-1015-azure
|
