my fork of prototorch
Go to file
blackfly c21913fdd4 Add tests/__init__.py
Adding the __init__.py file makes it possible to run `coverage run -m pytest`
from the project root.
2020-04-06 21:01:50 +02:00
.github/workflows Fix broken "Tests" workflow 2020-04-06 17:45:15 +02:00
examples Add examples/glvq_iris.py 2020-04-06 16:43:59 +02:00
prototorch Bump version: 0.0.0-dev1 → 0.1.0-dev0 2020-04-06 18:22:15 +02:00
tests Add tests/__init__.py 2020-04-06 21:01:50 +02:00
.bumpversion.cfg Bump version: 0.0.0-dev1 → 0.1.0-dev0 2020-04-06 18:22:15 +02:00
.codecov.yml Add .codecov.yml and codecov badge to README.md 2020-04-06 18:07:15 +02:00
.gitignore Add setup.py and other project files 2020-02-17 18:02:52 +01:00
LICENSE Initial commit 2020-02-07 10:11:36 +01:00
MANIFEST.in Update MANIFEST.in to include codecov and test scripts 2020-04-06 18:32:06 +02:00
README.md Add more version badges and bibtex section to README.md 2020-04-06 19:59:52 +02:00
RELEASE.md Add RELEASE.md 2020-04-06 18:52:12 +02:00
setup.py Bump version: 0.0.0-dev1 → 0.1.0-dev0 2020-04-06 18:22:15 +02:00
tox.ini Add setup.py and other project files 2020-02-17 18:02:52 +01:00

ProtoTorch

ProtoTorch is a PyTorch-based Python toolbox for bleeding-edge research in prototype-based machine learning algorithms.

GitHub version PyPI version Tests codecov Downloads GitHub license

Description

This is a Python toolbox brewed at the Mittweida University of Applied Sciences in Germany for bleeding-edge research in Learning Vector Quantization (LVQ) and potentially other prototype-based methods. Although, there are other (perhaps more extensive) LVQ toolboxes available out there, the focus of ProtoTorch is ease-of-use, extensibility and speed.

Many popular prototype-based Machine Learning (ML) algorithms like K-Nearest Neighbors (KNN), Generalized Learning Vector Quantization (GLVQ) and Generalized Matrix Learning Vector Quantization (GMLVQ) are implemented using the "nn" API provided by PyTorch.

Installation

ProtoTorch can be installed using pip.

pip install prototorch

To install the bleeding-edge features and improvements:

git clone https://github.com/si-cim/prototorch.git
git checkout dev
cd prototorch
pip install -e .

Usage

ProtoTorch is modular. It is very easy to use the modular pieces provided by ProtoTorch, like the layers, losses, callbacks and metrics to build your own prototype-based(instance-based) models. These pieces blend-in seamlessly with numpy and PyTorch to allow you mix and match the modules from ProtoTorch with other PyTorch modules.

ProtoTorch comes prepackaged with many popular LVQ algorithms in a convenient API, with more algorithms and techniques coming soon. If you would simply like to be able to use those algorithms to train large ML models on a GPU, ProtoTorch lets you do this without requiring a black-belt in high-performance Tensor computation.

Bibtex

If you would like to cite the package, please use this:

@misc{Ravichandran2020,
  author = {Ravichandran, J},
  title = {ProtoTorch},
  year = {2020},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/si-cim/prototorch}}
}