prototorch_models/README.md

66 lines
1.5 KiB
Markdown
Raw Normal View History

2021-04-21 13:02:55 +00:00
# ProtoTorch Models
2021-04-21 11:13:28 +00:00
2021-04-21 11:30:50 +00:00
Pre-packaged prototype-based machine learning models using ProtoTorch and
PyTorch-Lightning.
2021-04-21 13:02:55 +00:00
## 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`.
2021-04-21 19:34:32 +00:00
## Development setup
It is recommended that you use a virtual environment for development. If you do
not use `conda`, the easiest way to work with virtual environments is by using
[virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/). Once
you've installed it with `pip install virtualenvwrapper`, you can do the
following:
```sh
export WORKON_HOME=~/pyenvs
mkdir -p $WORKON_HOME
source /usr/local/bin/virtualenvwrapper.sh # might be different
# source ~/.local/bin/virtualenvwrapper.sh
mkvirtualenv pt
workon pt
git clone git@github.com:si-cim/prototorch_models.git
cd prototorch_models
git checkout dev
pip install -e .[all] # \[all\] if you are using zsh or MacOS
2021-04-21 19:34:32 +00:00
```
To assist in the development process, you may also find it useful to install
`yapf`, `isort` and `autoflake`. You can install them easily with `pip`.
2021-04-21 13:02:55 +00:00
## Available models
2021-04-27 12:35:17 +00:00
- GLVQ
- Siamese GLVQ
- Neural Gas
2021-05-04 13:11:16 +00:00
- GMLVQ
- Limited-Rank GMLVQ
2021-04-23 15:30:23 +00:00
## Work in Progress
2021-04-29 21:37:22 +00:00
2021-04-27 12:35:17 +00:00
- CBC
2021-04-29 21:37:22 +00:00
- LVQMLN
2021-04-23 15:30:23 +00:00
## Planned models
2021-04-29 21:37:22 +00:00
2021-04-27 12:35:17 +00:00
- Local-Matrix GMLVQ
- GTLVQ
- RSLVQ
- PLVQ
2021-04-29 21:37:22 +00:00
- SILVQ
- KNN
2021-05-04 13:11:16 +00:00
- LVQ1