julius/prototorch_models
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Jensun Ravichandran 2021-05-07 15:41:53 +02:00
parent 728131e9db
commit 63a5a98491
1 changed files with 36 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -5,9 +5,15 @@ PyTorch-Lightning.
## Installation ## Installation
To install this plugin, simple install To install this plugin, first install
[ProtoTorch](https://github.com/si-cim/prototorch) first by following the [ProtoTorch](https://github.com/si-cim/prototorch) with:
installation instructions there and then install this plugin by doing:
```sh
git clone https://github.com/si-cim/prototorch.git && cd prototorch
pip install -e .
```
and then install the plugin itself with:
```sh ```sh
git clone https://github.com/si-cim/prototorch_models.git && cd prototorch_models git clone https://github.com/si-cim/prototorch_models.git && cd prototorch_models
@ -28,9 +34,14 @@ following:
```sh ```sh
export WORKON_HOME=~/pyenvs export WORKON_HOME=~/pyenvs
mkdir -p $WORKON_HOME mkdir -p $WORKON_HOME
source /usr/local/bin/virtualenvwrapper.sh # might be different source /usr/local/bin/virtualenvwrapper.sh # location may vary
# source ~/.local/bin/virtualenvwrapper.sh
mkvirtualenv pt mkvirtualenv pt
```
Once you have a virtual environment setup, you can start install the `models`
plugin with:
```sh
workon pt workon pt
git clone git@github.com:si-cim/prototorch_models.git git clone git@github.com:si-cim/prototorch_models.git
cd prototorch_models cd prototorch_models
@ -43,23 +54,31 @@ To assist in the development process, you may also find it useful to install
## Available models ## Available models
- GLVQ - Generalized Learning Vector Quantization (GLVQ)
- Generalized Matrix Learning Vector Quantization (GMLVQ)
- Limited-Rank Matrix Learning Vector Quantization (LiRaMLVQ)
- Siamese GLVQ - Siamese GLVQ
- Neural Gas - Neural Gas (NG)
- GMLVQ
- Limited-Rank GMLVQ
## Work in Progress ## Work in Progress
- CBC - Classification-By-Components Network (CBC)
- LVQMLN - Learning Vector Quantization Multi-Layer Network (LVQMLN)
## Planned models ## Planned models
- Local-Matrix GMLVQ - Local-Matrix GMLVQ
- GTLVQ - Generalized Tangent Learning Vector Quantization (GTLVQ)
- RSLVQ - Robust Soft Learning Vector Quantization (RSLVQ)
- PLVQ - Probabilistic Learning Vector Quantization (PLVQ)
- SILVQ - Self-Incremental Learning Vector Quantization (SILVQ)
- KNN - K-Nearest Neighbors (KNN)
- LVQ1 - Learning Vector Quantization 1 (LVQ1)
## FAQ
### How do I update the plugin?
If you have already cloned and installed `prototorch` and the
`prototorch_models` plugin with the `-e` flag via `pip`, all you have to do is
navigate to those folders from your terminal and do `git pull` to update.