From 497eb70b7ee6bc298bf6aa0a96e36aa44d0d3e2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Geron?= Date: Wed, 6 Nov 2019 21:11:07 +0800 Subject: [PATCH] Update the installation instructions --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bedddfa..d4deeca 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,10 @@ Use any of the following services. **WARNING**: Please be aware that these services provide temporary environments: anything you do will be deleted after a while, so make sure you save anything you care about. -* Open this repository in [Binder](https://mybinder.org/v2/gh/ageron/handson-ml2/master): +* Open this repository in [Colaboratory](https://colab.research.google.com/github/ageron/handson-ml2/blob/master/): + + +* Or open it in [Binder](https://mybinder.org/v2/gh/ageron/handson-ml2/master): * _Note_: Most of the time, Binder starts up quickly and works great, but when handson-ml2 is updated, Binder creates a new environment from scratch, and this can take quite some time. @@ -23,11 +26,6 @@ Use any of the following services. * Or open it in [Deepnote](https://beta.deepnote.com/launch?template=data-science&url=https%3A//github.com/ageron/handson-ml2/blob/master/index.ipynb): -* Or open it in [Colaboratory](https://colab.research.google.com/github/ageron/handson-ml2/blob/master/): - - - * _Note_: Colab environments only contain the notebooks you open, they do not clone the rest of the project, so you need to do it yourself by running `!git clone https://github.com/ageron/handson-ml2` and `!mv handson-ml2/* /content` to have access to other files in this project (such as datasets and images). Moreover, Colab does not come with the latest libraries, so you need to run `!python3 -m pip install -U -r requirements.txt` then restart the environment (but do not reset it!). If you open multiple notebooks from this project, you only need to do this once (as long as you do not reset the runtimes). - ### Just want to quickly look at some notebooks, without executing any code? Browse this repository using [jupyter.org's notebook viewer](http://nbviewer.jupyter.org/github/ageron/handson-ml2/blob/master/index.ipynb): @@ -46,7 +44,16 @@ If you have a working Python 3.5+ environment and git is installed, then this pr $ python3 -m pip install --user --upgrade -r requirements.txt $ jupyter notebook -If you need more detailed installation instructions, or you want to use Anaconda, read the [detailed installation instructions](INSTALL.md). +Or using Anaconda: + + $ git clone https://github.com/ageron/handson-ml2.git + $ cd handson-ml2 + $ # Read `environment.yml` if you want to use a GPU. + $ conda env create -f /tmp/environment.yml + $ conda activate tf2 + $ jupyter notebook + +If you need more detailed installation instructions, read the [detailed installation instructions](INSTALL.md). ## Contributors I would like to thank everyone who contributed to this project, either by providing useful feedback, filing issues or submitting Pull Requests. Special thanks go to Haesun Park who helped on some of the exercise solutions, and to Steven Bunkley and Ziembla who created the `docker` directory.