Update readme
This commit is contained in:
parent
fe36e5fad9
commit
fa7b178028
24
README.md
24
README.md
@ -17,6 +17,30 @@ pip install -e .
|
||||
The plugin should then be available for use in your Python environment as
|
||||
`prototorch.models`.
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
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`.
|
||||
|
||||
## Available models
|
||||
|
||||
- [X] GLVQ
|
||||
|
Loading…
Reference in New Issue
Block a user