showml 1.2.0

A Python package of Machine Learning Algorithms implemented from scratch

ShowML

Show the ML Code!

A Python package of Machine Learning Algorithms implemented from scratch.

The aim of this package is to present the working behind fundamental Machine Learning algorithms in a transparent and modular way.

NOTE: The implementations of these algorithms are not thoroughly optimized for high computational efficiency

Installation

To install the package

$ pip install showml

To clone the repository and view the source files

$ git clone https://github.com/hasnainroopawalla/ShowML.git
$ cd ShowML
$ pip install -r requirements.txt

How to Contribute

Contents

Algorithms

• Linear Regression (from showml.supervised.regression import LinearRegression)
• Logistic Regression (from showml.supervised.regression import LogisticRegression)

Optimizers

• Stochastic/Batch/Mini-Batch Gradient Descent (from showml.optimizers import SGD)

Loss Functions

• Mean Squared Error (from showml.losses import MeanSquareError)
• Binary Cross Entropy (from showml.losses import BinaryCrossEntropy)

Contributing

1. Fork the repository
2. Install the necessary dependencies

$ pip install pre-commit mypy pytest

3. Commit and push your changes to your own branch
4. Before submitting a Pull Request, run these housekeeping checks locally

• Run pre-commit

$ pre-commit run -a

• Run mypy

$ mypy .

• Run tests

$ pytest

5. Once everything succeeds, create a Pull Request (CI will be triggered)