Update readme
This commit is contained in:
parent
e411592a52
commit
ee39ac516d
28
README.md
28
README.md
@ -1,4 +1,30 @@
|
|||||||
# prototorch_models
|
# ProtoTorch Models
|
||||||
|
|
||||||
Pre-packaged prototype-based machine learning models using ProtoTorch and
|
Pre-packaged prototype-based machine learning models using ProtoTorch and
|
||||||
PyTorch-Lightning.
|
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
|
||||||
|
Loading…
Reference in New Issue
Block a user