Hand Crafted Models
Simple linear model implementations from scratch.
Table of contents
- Overview
- Project Structure
- Getting started
- Citing this project
1. Overview
The repo consists of popular predictive linear models (i.e., linear and logistic regressions) and is intended for educational purposes to demonstrate the mathematics behind the models.
2. Project Structure
hand_crafted_models/
activations.py ...Activation function implementations
linear_regression.py ...Linear regression implementations
logistic_regression.py ...Logistic regression implementation
loss_functions.py ...Loss function implementations
optimization.py ...Optimizer implementations
utils.py ...Commonly used functions
requirements.txt ...project dependencies
setup.py
3. Getting Started
- Clone the project
git clone https://github.com/sadighian/hand_crafted_models.git
- Create a virtual environment
cd hand_crafted_models # Change to project directory
virtualenv -p python3 venv # Create the virtual environment
source venv/bin/activate # Start using the venv
- Install the project and its dependencies
pip3 install -e . # Execute command inside install directory
- Fit linear models with sample data
python3 tests/tests.py
4. Citing the Project
@misc{Hand Crafted Models,
author = {Jonathan Sadighian},
title = {Hand Crafted Models: Simple linear model implementations},
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/sadighian/hand_crafted_models}},
}