From f65a665157f41bef9934588495ce4376c277bfd7 Mon Sep 17 00:00:00 2001 From: Jensun Ravichandran Date: Mon, 7 Jun 2021 15:18:10 +0200 Subject: [PATCH] Update readme --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d40f5e4..b375cc9 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,9 @@ To install this plugin, simply run the following command: pip install prototorch_models ``` -The plugin should then be available for use in your Python environment as -`prototorch.models`. - -**Note: Installing the models plugin should automatically install a suitable -version of** [ProtoTorch](https://github.com/si-cim/prototorch). +**Installing the models plugin should automatically install a suitable version +of** [ProtoTorch](https://github.com/si-cim/prototorch). The plugin should then +be available for use in your Python environment as `prototorch.models`. ## Available models @@ -79,10 +77,10 @@ git checkout dev pip install -e .[all] # \[all\] if you are using zsh or MacOS ``` -**Note: Please avoid installing Tensorflow in this environment.** - 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`. +`yapf`, `isort` and `autoflake`. You can install them easily with `pip`. **Also, +please avoid installing Tensorflow in this environment. It is known to cause +problems with PyTorch-Lightning.** ## FAQ