diff --git a/machine_learning/README.md b/machine_learning/README.md index e69de29..6668dc5 100644 --- a/machine_learning/README.md +++ b/machine_learning/README.md @@ -0,0 +1,19 @@ +This repository contains several scripts integral to the development, training, and deployment of a machine learning model. + +**classifiers_test.py** + +*Purpose:* This script is used for testing various classifiers. + +*Functionality:* It conducts a series of tests on different classifiers to evaluate their performance and suitability for our model. + +**model_creation.py** + +*Purpose:* Responsible for creating and training the machine learning model. + +*Functionality:* Reads input data, trains the model and saves it to trained_model.pkl. + +**model_inference.py** + +*Purpose:* Utilizes the trained model to make predictions on new data. + +*Functionality:* Loads the model from trained_model.pkl, makes predictions on new data and outputs a binary table indicating collapse predictions. \ No newline at end of file