The goal of this project is to create a simple, interactive REPL (Read-Eval-Print-Loop) that allows users to interact with a variety of Large Language Models (LLMs). The project is mainly built on top of two Python libraries: langchain, which provides a convenient and flexible interface for working with LLMs, and rich which provides a user-friendly interface for the REPL. The REPL can also be launched in headledss mode and it can be interacted with using websocket.
Currently, the project is in development and only supports interaction with the ChatGPT but it has been structure to make it easy to extend it use any LLMs, including custom ones (by extending BaseLLM
in ./src/llm_repl/llms/__init__.py
).
ChatGPT can be interacted by using the models gpt-3.5-turbo
and gpt4
(For users who got GPT-4 API beta).
The REPL supports the following features:
The REPL won't wait for the model to finish generating the output, but it will start printing the output as soon as it is available.
The REPL supports conversation memory. This means that the model will remember the previous conversation and will use it to generate the next response.
The REPL supports Markdown rendering both of the input and the output.
PS: In this initial version of the REPL, the full Markdown syntax is only when running the tool in non-streaming
mode. In streaming
mode only code sections will be pretty printed.
The REPL can be run in headless mode. This means that it can be interacted with using a websocket. This is useful for integrating the REPL with other applications / other UIs.
To launch the REPL in headless mode, run the following command:
llm-repl --repl websocket --port <PORT>
COMING SOON...
COMING SOON...
pip install llm-repl
First export your OpenAI API key as an environment variable:
export OPENAI_API_KEY=<OPENAI_KEY>
Then run the REPL:
llm-repl
Or if you want to use a specific model:
llm-repl --llm chatgpt4
docker run -it --rm -e OPENAI_API_KEY=<OPENAI_KEY> phate/llm-repl
Or if you want to source the environment variables from a file, first create a file called .env
with the following content:
OPENAI_API_KEY=<OPENAI_KEY>
And then run the following command:
docker run -it --rm --env-file .env phate/llm-repl
To install the REPL in development mode
Then install the package in development mode:
pip install -e ".[DEV]"
Before contributing, please make sure to run the following commands:
pre-commit install