initial commit

Author: nikhilbarhate99

.gitignore

@@ -0,0 +1,12 @@
+__pycache__/
+venv/
+*.csv
+*.log
+*.pt
+*.pkl
+*.zip
+*.DS_Store
+*.pdf
+*.out
+*.png
+*.rdb

README.md

@@ -0,0 +1,74 @@
+# project-polybius
+
+## Overview
+
+project-polybius is a text based game that uses Large Language Models to generate new experiences for the player.
+This repo provides the code to deploy it on cloud and a client to interact with the deployed system.
+
+
+## Instructions
+
+### Running the services
+I have tested this code on google cloud platform's kubernetes engine (GKE) because it uses GCP's Vertex AI APIs for text generation, but technically it can run on any cloud or locally provided that an appropriate `generate_text()` function (imported in `llm-handler.py`) is implemented in its corresponding api_helper file. 
+
+After starting a kubernetes cluster, clone the repo:
+```
+git clone https://github.com/nikhilbarhate99/project-polybius.git
+cd project-polybius
+``` 
+Install minio on kubernetes cluster using helm (make sure helm is installed before)
+```
+helm repo add bitnami https://charts.bitnami.com/bitnami
+helm install -f ./minio/minio-config.yaml -n minio-ns --create-namespace minio-proj bitnami/minio
+```
+Deploy the system on the cluster, this will start running all the pods, services, deployments required for the game.
+```
+./deploy-cloud.sh
+```
+Run the following command to expose the rest service using:
+```
+kubectl apply -f expose-rest.yaml
+```
+After a while, the kubernetes cluster will assign an external IP to the `expose-rest-svc` service. 
+You can check this by running:
+```
+kubectl get all
+```
+**Important:** Now copy that external IP to the `REST_HOST` variable in the `global_variables.py` file. 
+This allows the client to find the rest service.
+
+### Running the client
+finally, once all the servcies are running on the cluster, we can install all the requirements in a virtual env and use the client to play the game:
+```
+python3 -m venv ./venv
+source venv/bin/activate
+pip3 install -r requirements.txt
+python3 polybius_client.py
+```
+As long as the cluster is running, multiple clients can play the game and their games will be saved in the Database.
+
+**Note:** To play the game (on client side) four files are required which can be zipped an distributed to users: `polybius_client.py`, `global_variables.py`, `utils.py`, `requirements.txt`
+
+## System
+
+The current architecture is simple as illustrated in the figure
+![](https://github.com/nikhilbarhate99/dcsc-project-polybius/blob/main/media/polybius_fig.png)
+
+
+## Examples
+
+| ![](https://github.com/nikhilbarhate99/dcsc-project-polybius/blob/main/media/game_pic_1.png) | ![](https://github.com/nikhilbarhate99/dcsc-project-polybius/blob/main/media/game_pic_2.png)  |
+| :---:|:---: |
+
+
+
+## To Do
+
+- [ ] Add Authentication
+- [ ] Better error handling for REST Success/Failures
+- [ ] Change to a JSON DB
+- [ ] Fix UI issues
+- [ ] Use logs service
+- [ ] Add support for different settings/genre for game stories
+- [ ] Implement `generate_text()` function for other LLM APIs e.g. Gemini, GPT4 etc.
+

deploy-cloud.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+kubectl apply -f redis/redis-deployment.yaml
+kubectl apply -f redis/redis-service.yaml
+
+kubectl apply -f rest/rest-deployment.yaml
+kubectl apply -f rest/rest-service.yaml
+
+# kubectl apply -f logs/logs-deployment.yaml
+
+kubectl apply -f llm/llm-deployment.yaml
+
+kubectl apply -f minio/minio-external-service.yaml
+
+# kubectl apply -f expose-rest.yaml
+
+# kubectl apply -f rest/rest-ingress.yaml

deploy-local.sh

@@ -0,0 +1,29 @@
+#!/bin/sh
+
+kubectl apply -f redis/redis-deployment.yaml
+kubectl apply -f redis/redis-service.yaml
+
+kubectl apply -f rest/rest-deployment.yaml
+kubectl apply -f rest/rest-service.yaml
+
+# kubectl apply -f logs/logs-deployment.yaml
+
+kubectl apply -f llm/llm-deployment.yaml
+
+kubectl apply -f minio/minio-external-service.yaml
+
+
+
+kubectl port-forward --address 0.0.0.0 service/redis 6379:6379 &
+
+kubectl port-forward -n minio-ns --address 0.0.0.0 service/minio-proj 9000:9000 &
+kubectl port-forward -n minio-ns --address 0.0.0.0 service/minio-proj 9001:9001 &
+
+
+# port forward for rest for local dev
+# kubectl port-forward service/rest-svc 5005:5005
+
+
+# kubectl apply -f expose-rest.yaml
+
+# kubectl apply -f rest/rest-ingress.yaml

deploy-minio-local.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+#
+# You can use this script to launch Redis and minio on Kubernetes
+# and forward their connections to your local computer. That means
+# you can then work on your worker-server.py and rest-server.py
+# on your local computer rather than pushing to Kubernetes with each change.
+#
+# To kill the port-forward processes us e.g. "ps augxww | grep port-forward"
+# to identify the processes ids
+#
+
+
+kubectl apply -f minio/minio-external-service.yaml
+
+# If you're using minio from the kubernetes tutorial this will forward those
+kubectl port-forward -n minio-ns --address 0.0.0.0 service/minio-proj 9000:9000 &
+kubectl port-forward -n minio-ns --address 0.0.0.0 service/minio-proj 9001:9001 &
+

expose-rest.yaml

@@ -0,0 +1,12 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: expose-rest-svc
+spec:
+  selector:
+    app: rest
+  ports:
+    - protocol: TCP
+      port: 5005
+      targetPort: 5005
+  type: LoadBalancer