prototorch/README.md

79 lines
3.0 KiB
Markdown
Raw Normal View History

2020-09-24 09:54:32 +00:00
# ProtoTorch: Prototype Learning in PyTorch
2020-02-17 17:00:12 +00:00
2020-09-24 09:54:32 +00:00
![ProtoTorch Logo](https://prototorch.readthedocs.io/en/latest/_static/horizontal-lockup.png)
2020-02-17 17:00:12 +00:00
2021-06-20 15:49:53 +00:00
[![Build Status](https://api.travis-ci.com/si-cim/prototorch.svg?branch=master)](https://travis-ci.com/github/si-cim/prototorch)
2020-04-08 20:34:26 +00:00
![tests](https://github.com/si-cim/prototorch/workflows/tests/badge.svg)
2020-04-11 12:22:34 +00:00
[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/si-cim/prototorch?color=yellow&label=version)](https://github.com/si-cim/prototorch/releases)
[![PyPI](https://img.shields.io/pypi/v/prototorch)](https://pypi.org/project/prototorch/)
[![codecov](https://codecov.io/gh/si-cim/prototorch/branch/master/graph/badge.svg)](https://codecov.io/gh/si-cim/prototorch)
2020-04-11 12:22:34 +00:00
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/76273904bf9343f0a8b29cd8aca242e7)](https://www.codacy.com/gh/si-cim/prototorch?utm_source=github.com&utm_medium=referral&utm_content=si-cim/prototorch&utm_campaign=Badge_Grade)
[![GitHub license](https://img.shields.io/github/license/si-cim/prototorch)](https://github.com/si-cim/prototorch/blob/master/LICENSE)
2020-02-17 17:00:12 +00:00
2020-09-24 09:54:32 +00:00
*Tensorflow users, see:* [ProtoFlow](https://github.com/si-cim/protoflow)
2020-02-17 17:00:12 +00:00
## Description
This is a Python toolbox brewed at the Mittweida University of Applied Sciences
2020-09-24 09:54:32 +00:00
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.
2020-02-17 17:00:12 +00:00
## Installation
ProtoTorch can be installed using `pip`.
2020-04-11 12:22:34 +00:00
```bash
2020-07-30 09:19:02 +00:00
pip install -U prototorch
```
To also install the extras, use
```bash
2021-02-10 16:02:02 +00:00
pip install -U prototorch[all]
2020-02-17 17:00:12 +00:00
```
2021-04-29 12:31:36 +00:00
*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\]`.*
2021-02-10 16:02:02 +00:00
2020-03-30 11:30:10 +00:00
To install the bleeding-edge features and improvements:
2020-04-11 12:22:34 +00:00
```bash
2020-03-30 11:30:10 +00:00
git clone https://github.com/si-cim/prototorch.git
cd prototorch
2021-04-29 12:31:36 +00:00
git checkout dev
2021-02-10 16:02:02 +00:00
pip install -e .[all]
2020-03-30 11:30:10 +00:00
```
2020-09-24 09:54:32 +00:00
## Documentation
2021-04-14 17:20:08 +00:00
The documentation is available at <https://www.prototorch.ml/en/latest/>. Should
that link not work try <https://prototorch.readthedocs.io/en/latest/>.
2020-02-17 17:00:12 +00:00
## 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
2020-09-24 09:54:32 +00:00
@misc{Ravichandran2020b,
author = {Ravichandran, J},
title = {ProtoTorch},
year = {2020},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/si-cim/prototorch}}
}