diff --git a/README.md b/README.md index 887b6429..540497c8 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,12 @@ python main.py --use_azure_openai To create a new starter user or starter persona (that MemGPT gets initialized with), create a new `.txt` file in [/memgpt/humans/examples](/memgpt/humans/examples) or [/memgpt/personas/examples](/memgpt/personas/examples), then use the `--persona` or `--human` flag when running `main.py`. For example: +```sh +# assuming you created a new file /memgpt/humans/examples/me.txt +python main.py +# Select me.txt during configuration process +``` +-- OR -- ```sh # assuming you created a new file /memgpt/humans/examples/me.txt python main.py --human me.txt @@ -116,6 +122,11 @@ python main.py --human me.txt ### GPT-3.5 support You can run MemGPT with GPT-3.5 as the LLM instead of GPT-4: ```sh +python main.py +# Select gpt-3.5 during configuration process +``` +-- OR -- +```sh python main.py --model gpt-3.5-turbo ``` @@ -124,6 +135,15 @@ python main.py --model gpt-3.5-turbo Please report any bugs you encounter regarding MemGPT running on GPT-3.5 to https://github.com/cpacker/MemGPT/issues/59. ### `main.py` flags +```text +--first + allows you to send the first message in the chat (by default, MemGPT will send the first message) +--debug + enables debugging output +``` + +
+Configure via legacy flags ```text --model @@ -132,10 +152,6 @@ Please report any bugs you encounter regarding MemGPT running on GPT-3.5 to htt load a specific persona file --human load a specific human file ---first - allows you to send the first message in the chat (by default, MemGPT will send the first message) ---debug - enables debugging output --archival_storage_faiss_path= load in document database (backed by FAISS index) --archival_storage_files="" @@ -145,6 +161,8 @@ Please report any bugs you encounter regarding MemGPT running on GPT-3.5 to htt --archival_storage_sqldb= load in SQL database ``` +
+ ### Interactive CLI commands @@ -153,8 +171,6 @@ These are the commands for the CLI, **not the Discord bot**! The Discord bot has While using MemGPT via the CLI (not Discord!) you can run various commands: ```text -// - enter multiline input mode (type // again when done) /exit exit the CLI /save