Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.53 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.53 KB
Raw

Ice Breaker GPT 🧊🔨

An application that generates a random interesting question to be used as an "ice breaker" in a conversation.

Usage (Run locally)

Go to the Groq Cloud to get your free API key and export it as an environment variable.

export GROQ_API_KEY='<api_key>'

Clone the github repository and navigate to the root folder.

git clone <repo-link>
cd ice-breaker-gpt

Create a virtual environement and install the necessary libraries from requirements.txt file.

python -m venv env
env\Scripts\activate
pip install -r requirements.txt

Run the FastAPI endpoint using uvicorn.

uvicorn app:app --reload

Append the running URL with /gradio to run the application. For instance for me the app runs locally at https://127.0.0.1:8000/gradio

Feel free to tweak the prompt in instructions.txt file to personalize your responses.

Deployment on Hugging Face 🤗

The application is deployed on Hugging Face as a space with a Gradio frontend.

Acknowledgements

I drew inspiration for this project and got the example questions (included in the prompt) from OmegleMe. Furthermore, I used this book to craft my system prompt for better responses.

Contribution

Feel free to open a PR or an issue in case of any drawbacks.