Update readme

This commit is contained in:
Jensun Ravichandran 2021-04-21 15:02:55 +02:00
parent e411592a52
commit ee39ac516d

View File

@ -1,4 +1,30 @@
# prototorch_models
# ProtoTorch Models
Pre-packaged prototype-based machine learning models using ProtoTorch and
PyTorch-Lightning.
## Installation
To install this plugin, simple install
[ProtoTorch](https://github.com/si-cim/prototorch) first by following the
installation instructions there and then install this plugin by doing:
```sh
git clone https://github.com/si-cim/prototorch_models.git && cd prototorch_models
pip install -e .
```
The plugin should then be available for use in your Python environment as
`prototorch.models`.
## Available models
- [X] GLVQ
- [ ] GMLVQ
- [ ] Local-Matrix GMLVQ
- [ ] Limited-Rank GMLVQ
- [ ] GTLVQ
- [ ] RSLVQ
- [ ] PLVQ
- [ ] LVQMLN
- [ ] CBC