-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated readme for quickstart (#698)
- Loading branch information
Showing
1 changed file
with
17 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,7 +31,6 @@ | |
| </details> | ||
|
|
||
| ## Quick setup | ||
|
|
||
| Join <a href="https://discord.gg/9GEQrxmVyE">Discord</a></strong> 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) | ||
|
|
@@ -49,35 +48,34 @@ You can see the full list of available commands when you enter `/` into the mess | |
| </div> | ||
|
|
||
| ## 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](https://arxiv.org/abs/2310.08560). | ||
|
|
||
| ## Running MemGPT locally | ||
|
|
||
| Install MemGPT: | ||
| ```sh | ||
| pip install -U pymemgpt | ||
| ``` | ||
|
|
||
| Now, you can run MemGPT and start chatting with a MemGPT agent with: | ||
| ```sh | ||
| pip install pymemgpt | ||
| memgpt run | ||
| ``` | ||
|
|
||
| Add your OpenAI API key to your environment: | ||
| If you're running MemGPT for the first time, you'll see two quickstart options: | ||
|
|
||
| ```sh | ||
| 1. **OpenAI**: select this if you'd like to run MemGPT with OpenAI models like GPT-4 (requires an OpenAI API key) | ||
| 2. **MemGPT Free Endpoint**: select this if you'd like to try MemGPT on a top open LLM for free (currently variants of Mixtral 8x7b!) | ||
|
|
||
| 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: | ||
| Neither of these options require you to have an LLM running on your own machine. If you'd like to run MemGPT with your custom LLM setup (or on OpenAI Azure), select **Other** to proceed to the advanced setup. | ||
|
|
||
| ### Advanced setup | ||
| You can reconfigure MemGPT's default settings by running: | ||
| ```sh | ||
| memgpt run | ||
| memgpt configure | ||
| ``` | ||
|
|
||
| You can run the following commands in the MemGPT CLI prompt: | ||
| ### In-chat commands | ||
| You can run the following commands in the MemGPT CLI prompt which chatting with an agent: | ||
| * `/exit`: Exit the CLI | ||
| * `/attach`: Attach a loaded data source to the agent | ||
| * `/save`: Save a checkpoint of the current agent/conversation state | ||
|
|
@@ -92,14 +90,12 @@ You can run the following commands in the MemGPT CLI prompt: | |
| * `/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.readme.io | ||
|
|
||
| ## Installing from source | ||
|
|
||
| To install MemGPT from source, start by cloning the repo: | ||
| ```sh | ||
| git clone [email protected]:cpacker/MemGPT.git | ||
|
|
@@ -130,7 +126,7 @@ poetry install | |
| </details> | ||
|
|
||
| ## Support | ||
| For issues and feature requests, please [open a GitHub issue](https://github.com/cpacker/MemGPT/issues) or message us on our `#support` channel on [Discord](https://discord.gg/9GEQrxmVyE) | ||
| For issues and feature requests, please [open a GitHub issue](https://github.com/cpacker/MemGPT/issues) or message us on our `#support` channel on [Discord](https://discord.gg/9GEQrxmVyE). | ||
|
|
||
| ## Datasets | ||
| Datasets used in our [paper](https://arxiv.org/abs/2310.08560) can be downloaded at [Hugging Face](https://huggingface.co/MemGPT). | ||
|
|
@@ -143,4 +139,4 @@ Datasets used in our [paper](https://arxiv.org/abs/2310.08560) can be downloaded | |
| - [x] Add official gpt-3.5-turbo support ([discussion](https://github.com/cpacker/MemGPT/discussions/66)) | ||
| - [x] CLI UI improvements ([issue](https://github.com/cpacker/MemGPT/issues/11)) | ||
| - [x] Add support for other LLM backends ([issue](https://github.com/cpacker/MemGPT/issues/18), [discussion](https://github.com/cpacker/MemGPT/discussions/67)) | ||
| - [ ] Release MemGPT family of open models (eg finetuned Mistral) ([discussion](https://github.com/cpacker/MemGPT/discussions/67)) | ||
| - [ ] Release MemGPT family of open models (eg finetuned Mistral) ([discussion](https://github.com/cpacker/MemGPT/discussions/67)) | ||