From 2d0e6f8de72d98f740c256b4559b710ea0d6926c Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Wed, 3 Feb 2021 10:41:57 +0100 Subject: [PATCH] update install instructions (#64) * update install instructions * Apply suggestions from code review Co-authored-by: chaton Co-authored-by: chaton --- README.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 33c94f6653..061a03ab0b 100644 --- a/README.md +++ b/README.md @@ -50,21 +50,25 @@ Pip / conda ```bash -pip install lightning-flash +pip install lightning-flash -U ``` -Master -```bash -pip install git+https://github.com/PytorchLightning/lightning-flash.git@master --upgrade -``` - -Source - -``` bash -git clone https://github.com/PyTorchLightning/lightning-flash.git -cd lightning-flash -pip install -e . -``` +The latest version from source +- using `pip` + ```bash + # with git + pip install git+https://github.com/PytorchLightning/lightning-flash.git@master + # OR from an archive + pip install https://github.com/PyTorchLightning/lightning-flash/archive/master.zip + ``` +- using native `setuptools` + ``` bash + # clone flash repository locally + git clone https://github.com/PyTorchLightning/lightning-flash.git + cd lightning-flash + # install in editable mode + pip install -e . + ``` ---