handson-ml/README.md

80 lines
5.3 KiB
Markdown
Raw Normal View History

2022-02-19 10:52:43 +01:00
Machine Learning Notebooks, 3rd edition
=================================
2016-02-16 21:40:20 +01:00
2017-04-30 10:23:21 +02:00
This project aims at teaching you the fundamentals of Machine Learning in
2022-05-18 10:54:39 +02:00
python. It contains the example code and solutions to the exercises in the third edition of my O'Reilly book [Hands-on Machine Learning with Scikit-Learn, Keras and TensorFlow (3rd edition)](https://homl.info/er3):
2016-09-27 14:08:23 +02:00
<a href="https://homl.info/er3"><img src="https://learning.oreilly.com/library/cover/9781098125967/300w/" title="book" width="150" border="0" /></a>
2022-05-18 10:54:39 +02:00
**Note**: If you are looking for the second edition notebooks, check out [ageron/handson-ml2](https://github.com/ageron/handson-ml2). For the first edition, see [ageron/handson-ml](https://github.com/ageron/handson-ml).
2016-02-16 21:40:20 +01:00
## Quick Start
2016-02-16 21:40:20 +01:00
### Want to play with these notebooks online without having to install anything?
Use any of the following services (I recommended Colab or Kaggle, since they offer free GPUs and TPUs).
**WARNING**: _Please be aware that these services provide temporary environments: anything you do will be deleted after a while, so make sure you download any data you care about._
2016-02-18 00:30:04 +01:00
* <a href="https://colab.research.google.com/github/ageron/handson-ml3/blob/main/" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
2019-11-06 14:11:07 +01:00
* <a href="https://homl.info/kaggle/"><img src="https://kaggle.com/static/images/open-in-kaggle.svg" alt="Open in Kaggle" /></a>
2016-02-18 00:30:04 +01:00
* <a href="https://mybinder.org/v2/gh/ageron/handson-ml3/HEAD?filepath=%2Findex.ipynb"><img src="https://mybinder.org/badge_logo.svg" alt="Launch binder" /></a>
* <a href="https://homl.info/deepnote/"><img src="https://deepnote.com/buttons/launch-in-deepnote-small.svg" alt="Launch in Deepnote" /></a>
2016-02-18 00:30:04 +01:00
### Just want to quickly look at some notebooks, without executing any code?
2016-02-18 00:30:04 +01:00
* <a href="https://nbviewer.jupyter.org/github/ageron/handson-ml3/blob/main/index.ipynb"><img src="https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg" alt="Render nbviewer" /></a>
* [github.com's notebook viewer](https://github.com/ageron/handson-ml3/blob/main/index.ipynb) also works but it's not ideal: it's slower, the math equations are not always displayed correctly, and large notebooks often fail to open.
### Want to run this project using a Docker image?
Read the [Docker instructions](https://github.com/ageron/handson-ml3/tree/main/docker).
2016-02-18 00:30:04 +01:00
### Want to install this project on your own machine?
2016-02-18 00:30:04 +01:00
2022-05-18 10:54:39 +02:00
Start by installing [Anaconda](https://www.anaconda.com/products/distribution) (or [Miniconda](https://docs.conda.io/en/latest/miniconda.html)), [git](https://git-scm.com/downloads), and if you have a TensorFlow-compatible GPU, install the [GPU driver](https://www.nvidia.com/Download/index.aspx), as well as the appropriate version of CUDA and cuDNN (see TensorFlow's documentation for more details).
2019-12-16 16:11:50 +01:00
Next, clone this project by opening a terminal and typing the following commands (do not type the first `$` signs on each line, they just indicate that these are terminal commands):
2019-11-06 14:11:07 +01:00
$ git clone https://github.com/ageron/handson-ml3.git
$ cd handson-ml3
2019-12-16 16:11:50 +01:00
Next, run the following commands:
2021-02-15 10:28:28 +01:00
$ conda env create -f environment.yml
$ conda activate homl3
2019-12-16 16:11:50 +01:00
$ python -m ipykernel install --user --name=python3
Finally, start Jupyter:
2019-11-06 14:11:07 +01:00
$ jupyter notebook
2019-12-16 16:11:50 +01:00
If you need further instructions, read the [detailed installation instructions](INSTALL.md).
# FAQ
2021-03-19 23:46:50 +01:00
**Which Python version should I use?**
2022-02-19 10:52:43 +01:00
I recommend Python 3.8. If you follow the installation instructions above, that's the version you will get. Most code will work with other versions of Python 3, but some libraries do not support Python 3.9 or 3.10 yet, which is why I recommend Python 3.8.
2021-03-19 23:46:50 +01:00
**I'm getting an error when I call `load_housing_data()`**
2021-03-19 23:46:50 +01:00
Make sure you call `fetch_housing_data()` *before* you call `load_housing_data()`. If you're getting an HTTP error, make sure you're running the exact same code as in the notebook (copy/paste it if needed). If the problem persists, please check your network configuration.
2021-03-19 23:46:50 +01:00
**I'm getting an SSL error on MacOSX**
2022-02-19 10:52:43 +01:00
You probably need to install the SSL certificates (see this [StackOverflow question](https://stackoverflow.com/questions/27835619/urllib-and-ssl-certificate-verify-failed-error)). If you downloaded Python from the official website, then run `/Applications/Python\ 3.8/Install\ Certificates.command` in a terminal (change `3.8` to whatever version you installed). If you installed Python using MacPorts, run `sudo port install curl-ca-bundle` in a terminal.
2021-03-19 23:46:50 +01:00
**I've installed this project locally. How do I update it to the latest version?**
See [INSTALL.md](INSTALL.md)
**How do I update my Python libraries to the latest versions, when using Anaconda?**
See [INSTALL.md](INSTALL.md)
## Contributors
2022-06-02 00:04:35 +02:00
I would like to thank everyone [who contributed to this project](https://github.com/ageron/handson-ml3/graphs/contributors), either by providing useful feedback, filing issues or submitting Pull Requests. Special thanks go to Haesun Park and Ian Beauregard who reviewed every notebook and submitted many PRs, including help on some of the exercise solutions. Thanks as well to Steven Bunkley and Ziembla who created the `docker` directory, and to github user SuperYorio who helped on some exercise solutions. And last but not least, thanks a lot to Victor Khaustov who submitted plenty of excellent PRs, fixing many errors.