pyfit 0.0.3

A simple Machine Learning library

pyfit

pyfit is a simple Machine Learning library built with Python and NumPy for educational purposes.

Overview

This project's main goal is to help ML students and enthusiasts get a deeper understanding of the Machine Learning workflow and main algorithms, by implementing them from scratch.

As a Python package, it also strives to define a clean, pythonic API and follow good coding practices, including type annotations.

Status

pyfit is currently in alpha status. See Progress for details.

Content

• Data Preprocessing [ source | tests ]
• Metrics [ source | tests ]
• Plotting [ source ]
• K-Nearest Neighbors [ source | tests ]
• Neural Networks [ source ]
• ... More to come!

Development Notes

Checking the code

pyfit uses the following tools:

• black for code formatting.
• pylint and mypy for linting.
• pytest for testing.

Run the following commands to check the codebase.

> python -m pylint ./pyfit # linting (including type checks)
> python -m mypy .         # type checks only
> python -m pytest .       # test suite

Launching demos

> python -m demos.<filename>

Uploading the package to PyPI

> python setup.py sdist bdist_wheel
> python -m twine upload dist/*