79 lines
3.0 KiB
Markdown
79 lines
3.0 KiB
Markdown
# ProtoTorch: Prototype Learning in PyTorch
|
|
|
|
|
|
|
|
[](https://travis-ci.com/github/si-cim/prototorch)
|
|
|
|
[](https://github.com/si-cim/prototorch/releases)
|
|
[](https://pypi.org/project/prototorch/)
|
|
[](https://codecov.io/gh/si-cim/prototorch)
|
|
[](https://www.codacy.com/gh/si-cim/prototorch?utm_source=github.com&utm_medium=referral&utm_content=si-cim/prototorch&utm_campaign=Badge_Grade)
|
|
[](https://github.com/si-cim/prototorch/blob/master/LICENSE)
|
|
|
|
*Tensorflow users, see:* [ProtoFlow](https://github.com/si-cim/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`.
|
|
```bash
|
|
pip install -U prototorch
|
|
```
|
|
To also install the extras, use
|
|
```bash
|
|
pip install -U prototorch[all]
|
|
```
|
|
|
|
*Note: If you're using [ZSH](https://www.zsh.org/) (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:
|
|
```bash
|
|
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](https://githooks.com).
|
|
[Pre-commit](https://pre-commit.com) 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:
|
|
```bash
|
|
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](https://www.conventionalcommits.org/en/v1.0.0/#specification).
|
|
|
|
## Bibtex
|
|
|
|
If you would like to cite the package, please use this:
|
|
```bibtex
|
|
@misc{Ravichandran2020b,
|
|
author = {Ravichandran, J},
|
|
title = {ProtoTorch},
|
|
year = {2020},
|
|
publisher = {GitHub},
|
|
journal = {GitHub repository},
|
|
howpublished = {\url{https://github.com/si-cim/prototorch}}
|
|
}
|