my fork of prototorch
Go to file
Alexander Engelsberger 5b2ab34232 Add plugin loader.
2021-04-13 12:36:22 +02:00
.github/workflows Update github action 'tests' 2020-04-14 20:19:23 +02:00
examples Update iris example 2021-03-26 16:06:11 +01:00
prototorch Add plugin loader. 2021-04-13 12:36:22 +02:00
tests Fix int fill-value error in test_modules.py 2020-07-30 11:42:37 +02:00
.bumpversion.cfg Bump version: 0.1.1-dev0 → 0.1.1-rc0 2020-04-27 12:56:42 +02:00
.codacy.yml Fix things codacy complains about 2020-09-24 11:53:35 +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
.travis.yml Update .travis.yml 2021-02-10 17:04:04 +01:00
LICENSE Initial commit 2020-02-07 10:11:36 +01:00
MANIFEST.in Update manifest 2020-07-13 09:32:38 +02:00
README.md Update setup.py and README.md 2021-02-10 17:02:02 +01:00
RELEASE.md Fix things codacy complains about 2020-09-24 11:53:35 +02:00
requirements.txt Remove some requirements from requirements.txt 2020-04-15 12:12:44 +02:00
setup.py Add plugin loader. 2021-04-13 12:36:22 +02:00
tox.ini Update tox.ini to use coverage 2020-04-06 21:05:57 +02:00

ProtoTorch: Prototype Learning in PyTorch

ProtoTorch Logo

Build Status tests GitHub tag (latest by date) PyPI codecov Codacy Badge PyPI - Downloads GitHub license

Tensorflow users, see: ProtoFlow

Description

This is a Python toolbox brewed at the Mittweida University of Applied Sciences in Germany for bleeding-edge research in Prototype-based Machine Learning methods and other interpretable models. The focus of ProtoTorch is ease-of-use, extensibility and speed.

Installation

ProtoTorch can be installed using pip.

pip install -U prototorch

To also install the extras, use

pip install -U prototorch[all]

Note: If you're using ZSH, the square brackets [ ] have to be escaped like so: \[\], making the install command pip install -U prototorch\[all\].

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 .[all]

Documentation

The documentation is available at https://prototorch.readthedocs.io/en/latest/

Usage

For researchers

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 Keras allowing you to mix and match the modules from ProtoFlow with other modules in torch.nn.

For engineers

ProtoTorch comes prepackaged with many popular Learning Vector Quantization (LVQ)-like algorithms in a convenient API. 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 computing.

Bibtex

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

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