diff --git a/README.md b/README.md index d20cf6045cf9e9c01add9f64985eb12539d4b6fe..ba1d31dbc6985d36c0f1776110c7e075739c62ef 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,26 @@ -ML-Predictor -requires 2 terminal to run +# ML-Predictor +A full stack machine learning application using frontend (React), backend (FastAPI) and tailwindcss. -backend terminal run: -python main.py +## Features +- ✅ Upload and Preprocessing Json/CSV for training/testing datas. +- ✅ Training ML model using ANNs from Autokeras +- ✅ Postprocessing trained ML model for relevant datas for visualization and interpretation. +- ✅ Fredicting output values using trained ML models stored under app's directory. + +## Installation +```bash +git clone https://git-ce.rwth-aachen.de/milson_sung/ML-Predictor.git +```installation for both frontend and backend + +cd ML-Predictor/frontend +npm install -frontend terminal run: -npm run dev \ No newline at end of file +cd ML-Predictor/backend +pip install -r requirements.txt + +- launching the app requires two terminal, each for frontend and backend +cd ML-Predictor/frontend +npm run dev + +cd ML-Predictor/backend +python main.py