my fork of prototorch
Go to file
2023-06-20 16:34:41 +02:00
.github ci: update python versions 2023-06-20 16:34:41 +02:00
docs build: bump version 0.7.4 → 0.7.5 2022-12-05 17:03:04 +01:00
examples chore: fix minor errors and upgrade codebase 2023-06-20 16:06:53 +02:00
prototorch chore: switch to pytorch 2.0+ 2023-06-20 16:27:54 +02:00
tests chore: fix minor errors and upgrade codebase 2023-06-20 16:06:53 +02:00
.bumpversion.cfg build: bump version 0.7.4 → 0.7.5 2022-12-05 17:03:04 +01:00
.gitignore refactor(api)!: merge the new api changes into dev 2021-06-18 18:20:30 +02:00
.pre-commit-config.yaml feat: add gmlvq example 2023-06-20 15:12:32 +02:00
.readthedocs.yml fix: python is python3.9 2021-06-20 17:49:53 +02:00
.remarkrc Add remarkrc 2021-06-17 14:25:52 +02:00
LICENSE chore: housekeeping 2022-03-10 14:46:56 +01:00
MANIFEST.in Update manifest 2020-07-13 09:32:38 +02:00
README.md Use github actions for CI (#10) 2022-01-10 20:23:18 +01:00
RELEASE.md [QA] Remove duplicate headings 2021-06-01 19:18:37 +02:00
setup.cfg chore: reorganize setup.cfg 2022-01-10 20:32:29 +01:00
setup.py chore: switch to pytorch 2.0+ 2023-06-20 16:27:54 +02:00

ProtoTorch: Prototype Learning in PyTorch

ProtoTorch Logo

tests GitHub tag (latest by date) PyPI 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/.

Contribution

This repository contains definition for git hooks. Pre-commit is automatically installed as development dependency with prototorch or you can install it manually with pip install pre-commit.

Please install the hooks by running:

pre-commit install
pre-commit install --hook-type commit-msg

before creating the first commit.

The commit will fail if the commit message does not follow the specification provided here.

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