ham-detector

The purpose of this project is to deploy a classifier that detects if a given text message is spam or not (ham).

Table of Contents

• Installation
• Usage
• Features
• Configuration
• Examples
• Authors
• Acknowledgements

Installation

1. Clone the respository:

   git clone https://github.com/Avoiding-Regression/ham-detector.git

2. Navigate to the project directory:

   cd ham-detector

3. Create and activate a virtual environment (Optional but recommended):

   python3 -m venv env
   source env/bin/activate

4. Install the required dependencies:

   pip install -r requirements.txt

Usage

To run the script, use the below command:

python ham_execute.py (this can be renamed)

Features

• A list of key features of the project.
• Maybe, include a roadmap of planned features?

Configuration

To configure the application, edit the 'config.yaml' file with the below parameters

• 'parameter1': Description
• 'parameter2': Description

Examples

• we can have an example of how the code works here (optional)

  
  #example using function
  from module import function

results = function(arg1,arg2)

print(result)

### Authors
- Joseph Tabalon
- Nancy Yuan
- Brian Pak
### **Acknowledgements**
- [Spam Data Set](https://www.kaggle.com/datasets/uciml/sms-spam-collection-dataset)