my fork of prototorch
Go to file
Jensun Ravichandran 503ef0e05f Cleanup components
2021-05-17 16:58:57 +02:00
.github Update bug report issues template. 2021-05-11 13:35:38 +02:00
docs Remove copy paste error from documentation. 2021-05-13 11:56:38 +02:00
examples Update components 2021-04-29 18:06:26 +02:00
prototorch Cleanup components 2021-05-17 16:58:57 +02:00
tests [HOTFIX] Add missing iris.py and fix knnc bug 2021-05-11 17:20:48 +02:00
.bumpversion.cfg Bump version: 0.4.3 → 0.4.4 2021-05-11 17:17:49 +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
.readthedocs.yml Add docs 2021-04-14 19:20:08 +02:00
.travis.yml Fix travis.yml. 2021-05-10 17:15:05 +02: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 readme 2021-04-29 14:31:36 +02:00
RELEASE.md Add docs 2021-04-14 19:20:08 +02:00
setup.py Bump version: 0.4.3 → 0.4.4 2021-05-11 17:17:49 +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 (which is also the default shell on MacOS now), 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
cd prototorch
git checkout dev
pip install -e .[all]

Documentation

The documentation is available at https://www.prototorch.ml/en/latest/. Should that link not work try https://prototorch.readthedocs.io/en/latest/.

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}}
}