diff --git a/README.md b/README.md index f91da2a..4ff3506 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,34 @@ [![Banner](banner.png)](https://capsizegames.itch.io/chat-ai) -Official Chat AI repo which houses the templates and primary code responsible -for running and querying the chatbot and Google T5-Flan model. +# Chat AI: Run LLMs with your own hardware + +Chat AI is an interface that sits on top of a custom engine which is responsible for processing requests and responses +to and from an active Google T5-Flan model. --- ## Dev Setup -### Prerequisites +### Installation + +#### For development on Chat AI + +1. Clone [aiengine](https://github.com/Capsize-Games/chat-ai) +2. `cd aiengine && pip install -r requirements.txt` + +Chat AI is built on top of sdrunner which is responsible for handling the model's input and output sdrunner can be found here. + +#### Running the application + +``` +python main.py +``` + +--- + +## API -- Python 3.10 -- private repo from capsize games [aiengine](https://github.com/Capsize-Games/aiengine) +1. `pip install chat-ai` +2. `from chat_ai import ChatAI` +3. `ai = ChatAI()` +4. `ai.query(query="Hello, how are you?", type="chat", botname="ChatBot", username="User")`