-
Notifications
You must be signed in to change notification settings - Fork 114
/
README.md
205 lines (128 loc) · 12.2 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
**NB: this repo is for v1 of the fastai library. [v2](https://github.com/fastai/fastai) is the current version. v1 is still supported for bug fixes, but will not receive new features.**
[](https://pypi.python.org/pypi/fastai)
[](https://anaconda.org/fastai/fastai)
[](https://anaconda.org/fastai/fastai)
[](https://pypi.python.org/pypi/fastai)
[](https://pypi.python.org/pypi/fastai)
# fastai
The fastai library simplifies training fast and accurate neural nets using modern best practices. See the [fastai website](https://fastai1.fast.ai/) to get started. The library is based on research into deep learning best practices undertaken at [fast.ai](http://www.fast.ai), and includes \"out of the box\" support for [`vision`](https://fastai1.fast.ai/vision.html#vision), [`text`](https://fastai1.fast.ai/text.html#text), [`tabular`](https://fastai1.fast.ai/tabular.html#tabular), and [`collab`](https://fastai1.fast.ai/collab.html#collab) (collaborative filtering) models. For brief examples, see the [examples](https://github.com/fastai/fastai1/tree/master/examples) folder; detailed examples are provided in the full [documentation](https://fastai1.fast.ai/). For instance, here's how to train an MNIST model using [resnet18](https://arxiv.org/abs/1512.03385) (from the [vision example](https://github.com/fastai/fastai1/blob/master/examples/vision.ipynb)):
```python
from fastai.vision import *
path = untar_data(MNIST_PATH)
data = image_data_from_folder(path)
learn = cnn_learner(data, models.resnet18, metrics=accuracy)
learn.fit(1)
```
## Note for [course.fast.ai](http://course.fast.ai) students
This document is written for `fastai v1`, which we use for version 3 of the [course.fast.ai](http://course.fast.ai) deep learning courses. If you're following along with a course at [course18.fast.ai](http://course18.fast.ai) (i.e. the machine learning course, which isn't updated for v1) you need to use `fastai 0.7`; please follow the installation instructions [here](https://forums.fast.ai/t/fastai-v0-install-issues-thread/24652).
## Installation
**NB:** *fastai v1 currently supports Linux only, and requires **PyTorch v1** and **Python 3.6** or later. Windows support is at an experimental stage: it should work fine but it's much slower and less well tested. Since Macs don't currently have good Nvidia GPU support, we do not currently prioritize Mac development.*
`fastai-1.x` can be installed with either `conda` or `pip` package managers and also from source. At the moment you can't just run *install*, since you first need to get the correct `pytorch` version installed - thus to get `fastai-1.x` installed choose one of the installation recipes below using your favorite python package manager. Note that **PyTorch v1** and **Python 3.6** are the minimal version requirements.
It's highly recommended you install `fastai` and its dependencies in a virtual environment ([`conda`](https://conda.io/docs/user-guide/tasks/manage-environments.html) or others), so that you don't interfere with system-wide python packages. It's not that you must, but if you experience problems with any dependency packages, please consider using a fresh virtual environment just for `fastai`.
Starting with pytorch-1.x you no longer need to install a special pytorch-cpu version. Instead use the normal pytorch and it works with and without GPU. But [you can install the cpu build too](https://fastai1.fast.ai/install.html#cpu-build).
If you experience installation problems, please read about [installation issues](https://github.com/fastai/fastai1/blob/master/README.md#installation-issues).
If you are planning on using `fastai` in the jupyter notebook environment, make sure to also install the corresponding [packages](https://fastai1.fast.ai/install.html#jupyter-notebook-dependencies).
More advanced installation issues, such as installing only partial dependencies are covered in a dedicated [installation doc](https://fastai1.fast.ai/install.html).
### Conda Install
```bash
conda install -c pytorch -c fastai fastai=1.0.61
```
This will install the `pytorch` build with the latest `cudatoolkit` version. If you need a higher or lower `CUDA XX` build (e.g. CUDA 9.0), following the instructions [here](https://pytorch.org/get-started/locally/), to install the desired `pytorch` build.
Note that JPEG decoding can be a bottleneck, particularly if you have a fast GPU. You can optionally install an optimized JPEG decoder as follows (Linux):
```bash
conda uninstall --force jpeg libtiff -y
conda install -c conda-forge libjpeg-turbo pillow==6.0.0
CC="cc -mavx2" pip install --no-cache-dir -U --force-reinstall --no-binary :all: --compile pillow-simd
```
If you only care about faster JPEG decompression, it can be `pillow` or `pillow-simd` in the last command above, the latter speeds up other image processing operations. For the full story see [Pillow-SIMD](https://fastai1.fast.ai/performance.html#faster-image-processing).
### PyPI Install
```bash
pip install fastai==1.0.61
```
By default pip will install the latest `pytorch` with the latest `cudatoolkit`. If your hardware doesn't support the latest `cudatoolkit`, follow the instructions [here](https://pytorch.org/get-started/locally/), to install a `pytorch` build that fits your hardware.
### Bug Fix Install
If a bug fix was made in git and you can't wait till a new release is made, you can install the bleeding edge version of `fastai` with:
```
pip install git+https://github.com/fastai/fastai1.git
```
### Developer Install
The following instructions will result in a [pip editable install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs), so that you can `git pull` at any time and your environment will automatically get the updates:
```bash
git clone https://github.com/fastai/fastai1
cd fastai1
tools/run-after-git-clone
pip install -e ".[dev]"
```
Next, you can test that the build works by starting the jupyter notebook:
```bash
jupyter notebook
```
and executing an example notebook. For example load `examples/tabular.ipynb` and run it.
Please refer to [CONTRIBUTING.md](https://github.com/fastai/fastai1/blob/master/CONTRIBUTING.md) and [Notes For Developers](https://fastai1.fast.ai/dev/develop.html) for more details on how to contribute to the `fastai` project.
### Building From Source
If for any reason you can't use the prepackaged packages and have to build from source, this section is for you.
1. To build `pytorch` from source follow the [complete instructions](https://github.com/pytorch/pytorch#from-source). Remember to first install CUDA, CuDNN, and other required libraries as suggested - everything will be very slow without those libraries built into `pytorch`.
2. Next, you will also need to build `torchvision` from source:
```bash
git clone https://github.com/pytorch/vision
cd vision
python setup.py install
```
3. When both `pytorch` and `torchvision` are installed, first test that you can load each of these libraries:
```bash
import torch
import torchvision
```
to validate that they were installed correctly
Finally, proceed with `fastai` installation as normal, either through prepackaged pip or conda builds or installing from source ("the developer install") as explained in the sections above.
## Installation Issues
If the installation process fails, first make sure [your system is supported](https://github.com/fastai/fastai1/blob/master/README.md#is-my-system-supported). And if the problem is still not addressed, please refer to the [troubleshooting document](https://fastai1.fast.ai/troubleshoot.html).
If you encounter installation problems with conda, make sure you have the latest `conda` client (`conda install` will do an update too):
```bash
conda install conda
```
### Is My System Supported?
1. Python: You need to have python 3.6 or higher
2. CPU or GPU
The `pytorch` binary package comes with its own CUDA, CuDNN, NCCL, MKL, and other libraries so you don't have to install system-wide NVIDIA's CUDA and related libraries if you don't need them for something else. If you have them installed already it doesn't matter which NVIDIA's CUDA version library you have installed system-wide. Your system could have CUDA 9.0 libraries, and you can still use `pytorch` build with CUDA 10.0 libraries without any problem, since the `pytorch` binary package is self-contained.
The only requirement is that you have installed and configured the NVIDIA driver correctly. Usually you can test that by running `nvidia-smi`. While it's possible that this application is not available on your system, it's very likely that if it doesn't work, then you don't have your NVIDIA drivers configured properly. And remember that a reboot is always required after installing NVIDIA drivers.
3. Operating System:
Since fastai-1.0 relies on pytorch-1.0, you need to be able to install pytorch-1.0 first.
As of this moment pytorch.org's 1.0 version supports:
| Platform | GPU | CPU |
|----------|--------|--------|
| linux | binary | binary |
| mac | source | binary |
| windows | binary | binary |
Legend: `binary` = can be installed directly, `source` = needs to be built from source.
If there is no `pytorch` preview conda or pip package available for your system, you may still be able to [build it from source](https://pytorch.org/get-started/locally/).
4. How do you know which pytorch cuda version build to choose?
It depends on the version of the installed NVIDIA driver. Here are the requirements for CUDA versions supported by pre-built `pytorch` releases:
| CUDA Toolkit | NVIDIA (Linux x86_64) |
|--------------|-----------------------|
| CUDA 10.0 | >= 410.00 |
| CUDA 9.0 | >= 384.81 |
| CUDA 8.0 | >= 367.48 |
So if your NVIDIA driver is less than 384, then you can only use CUDA 8.0. Of course, you can upgrade your drivers to more recent ones if your card supports it.
You can find a complete table with all variations [here](https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html).
If you use NVIDIA driver 410+, you most likely want to install the `cudatoolkit=10.0` pytorch variant, via:
```bash
conda install -c pytorch pytorch cudatoolkit=10.0
```
or if you need a lower version, use one of:
```bash
conda install -c pytorch pytorch cudatoolkit=8.0
conda install -c pytorch pytorch cudatoolkit=9.0
```
For other options refer to the complete list of [the available pytorch variants](https://pytorch.org/get-started/locally/).
## Updates
In order to update your environment, simply install `fastai` in exactly the same way you did the initial installation.
Top level files `environment.yml` and `environment-cpu.yml` belong to the old fastai (0.7). `conda env update` is no longer the way to update your `fastai-1.x` environment. These files remain because the fastai course-v2 video instructions rely on this setup. Eventually, once fastai course-v3 p1 and p2 will be completed, they will probably be moved to where they belong - under `old/`.
## Contribution guidelines
If you want to contribute to `fastai`, be sure to review the [contribution guidelines](https://github.com/fastai/fastai1/blob/master/CONTRIBUTING.md). This project adheres to fastai's [code of conduct](https://github.com/fastai/fastai1/blob/master/CODE-OF-CONDUCT.md). By participating, you are expected to uphold this code.
We use GitHub issues for tracking requests and bugs, so please see [fastai forum](https://forums.fast.ai/) for general questions and discussion.
The fastai project strives to abide by generally accepted best practices in open-source software development:
## History
A detailed history of changes can be found [here](https://github.com/fastai/fastai1/blob/master/CHANGES.md).
## Copyright
Copyright 2017 onwards, fast.ai, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project's files except in compliance with the License. A copy of the License is provided in the LICENSE file in this repository.