PunGrumpy / machine-learning-python

A machine learning project that uses linear regression to predict a target variable

Machine Learning Project

This repository contains a machine learning project that uses linear regression to predict a target variable. The project is organized into separate modules for training the model, validating the data, and validating the model's performance. Automated workflows for these tasks are set up using GitHub Actions.

Project Structure

machine-learning-python/
├── .github
│  └── workflows
│     ├── main.yml
├── requirements.txt
├── src
│  ├── data
│  │  ├── create_dataset.py
│  │  ├── prepare_data.py
│  │  └── validate_data.py
│  ├── model
│  │  ├── model.py
│  │  └── validate_model.py
│  └── utils
│     └── load_and_save.py
└── tests
   └── test_model.py

Getting Started

1. Clone this repository.
2. Install the required Python packages: pip install -r requirements.txt.
3. Validate the data: python src/validate_data.py.
4. Train the model: python src/model.py.
5. Validate the model: python src/validate_model.py.
6. Run the test suite: pytest tests/.

Automated Workflows

This project uses GitHub Actions to automate several tasks:

• When you push to the repository or open a pull request, GitHub Actions will automatically validate the data, train the model, and validate the model's performance.
• If any of these tasks fail, GitHub Actions will open an issue in the repository.

Please see the GitHub Actions documentation for more information on how this works.

Contributing

Please open an issue to discuss proposed changes before submitting a pull request.

License

This project is licensed under the terms of the MIT license.