update readme

sephiran · May 21, 2023 · c95153d · c95153d
1 parent 9d40dca
commit c95153d
Show file tree

Hide file tree

Showing 2 changed files with 86 additions and 91 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,16 @@
 # Applied Data Science Projektarbeit
 
-This is our awesome ADS AirBnB Project.
+This is our awesome AirBnB price prediction and flat description generator project.
 
-# Implemented functions
+Launch the project with ```docker-compose up```and open Jupyter Lab which runs on https://127.0.0.1:8888 to run the Jupyter Notebooks.
+
+# Implemented stuff
 
 - Web scraping from AirBnb
 - Web-API call to opendata.swiss to get rental prices of Zurich
+- EDA
+- Sentiment analysis on comments
+- Everything runs via Docker / Docker-Compose
+- PostreSQL DB container to save/read data
+- GPT-2 Model to generate apartement descriptions
+- Regerssion model to predict the prices for AirBnB apartements