https://github.com/si-cim/prototorch

ProtoTorch is a PyTorch-based Python toolbox for bleeding-edge research in prototype-based machine learning algorithms.
https://github.com/si-cim/prototorch

interpretable-ai lvq machine-learning python pytorch

Last synced: about 2 months ago
JSON representation

ProtoTorch is a PyTorch-based Python toolbox for bleeding-edge research in prototype-based machine learning algorithms.

• Host: GitHub
• URL: https://github.com/si-cim/prototorch
• Owner: si-cim
• License: other
• Created: 2020-02-07T09:11:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-30T08:03:08.000Z (about 1 year ago)
• Last Synced: 2025-03-25T15:15:34.841Z (2 months ago)
• Topics: interpretable-ai, lvq, machine-learning, python, pytorch
• Language: Python
• Size: 412 KB
• Stars: 19
• Watchers: 5
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ProtoTorch: Prototype Learning in PyTorch

![ProtoTorch Logo](https://prototorch.readthedocs.io/en/latest/_static/horizontal-lockup.png)

![tests](https://github.com/si-cim/prototorch/workflows/tests/badge.svg)

[![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/)

[![GitHub license](https://img.shields.io/github/license/si-cim/prototorch)](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 . Should

that link not work try .

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

}