Edit readme

README.md

@@ -9,4 +9,22 @@ app_file: app.py
 pinned: false
 ---
 
-An example chatbot using [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
+This chatbot was created as part of the lab assignment in **ID2223 - Scalable Machine Learning**. The premise of the task was to finetune an existing model and to display it in the UI.
+
+Our basemodel is **unsloth/Llama-3.2-3B-Instruct**. Our hyperparameters for the fine tuning were:
+
+- r=4
+- lora_alpha=8
+- lora_dropout=0.8
+
+Higher ranks or lower dropout rates led to massive overfitting which was explored through trial and error.
+
+The datasource used for the fine tuning was a chess dataset containing chess games and their respective average elo. The dataset can be found [here](https://huggingface.co/datasets/pjarbas312/chessllm).
+It roughly contains the same amount of data points as the FineTome 100k dataset.
+
+The idea is to fine tune the model so that it can recognize chess games and make predictions on them. The base model tends to hallucinate when given a chess game not understanding the context whilst the fine tuned version recognizes the chess game and guesses the elo.
+With chess gaining popularity and especially in the wake of the world chess championship it is a useful addition in our opinion.
+
+As the fine tuning takes some time and GPUs are not always available we checkpoint the progress after a certain amount of steps enabling us to resume the training if it was stopped abruptly.
+
+For the frontend we decided to use Gradio and its built-in components to display the chatbot. Additionally to the chatbot ui we integrated a chess chatbox which accepts chess games in the format displayed in the placeholder, as well as a chessboard which shows the moves that were played in that chess match. An example dataset containing chess moves can be found [here](https://huggingface.co/datasets/mlabonne/chessllm).