diff --git a/website/_harp.json b/website/_harp.json index 7794f26c0..8c16ccc16 100644 --- a/website/_harp.json +++ b/website/_harp.json @@ -71,7 +71,8 @@ { "id": 3, "title": "3.x", "checked": true }] }, { "id": "config", "title": "Configuration", "multiple": true, "options": [ - {"id": "venv", "title": "virtualenv", "help": "Use a virtual environment and install spaCy into a user directory" }] + {"id": "venv", "title": "virtualenv", "help": "Use a virtual environment and install spaCy into a user directory" }, + {"id": "gpu", "title": "GPU", "help": "Run spaCy on GPU to make it faster. Requires an NVDIA graphics card with CUDA 2+. See section below for more info."}] }, { "id": "model", "title": "Models", "multiple": true, "options": [ { "id": "en", "title": "English", "meta": "50MB" }, diff --git a/website/docs/usage/index.jade b/website/docs/usage/index.jade index cb1ab5754..9e31ef19c 100644 --- a/website/docs/usage/index.jade +++ b/website/docs/usage/index.jade @@ -21,10 +21,15 @@ p +qs({config: 'venv', os: 'linux'}) source .env/bin/activate +qs({config: 'venv', os: 'windows'}) .env\Scripts\activate - +qs({package: 'pip'}) pip install -U spacy + +qs({config: 'gpu', os: 'mac'}) export CUDA_HOME=/usr/local/cuda-8.0 + +qs({config: 'gpu', os: 'mac'}) export PATH=$PATH:$CUDA_HOME/bin + +qs({config: 'gpu', os: 'linux'}) export CUDA_HOME=/usr/local/cuda-8.0 + +qs({config: 'gpu', os: 'linux'}) export PATH=$PATH:$CUDA_HOME/bin + +qs({config: 'gpu', package: 'pip'}) pip install -U chainer + +qs({config: 'gpu', package: 'conda'}) conda install -c anaconda chainer - +qs({package: 'conda'}) conda config --add channels conda-forge - +qs({package: 'conda'}) conda install spacy + +qs({package: 'pip'}) pip install -U spacy + +qs({package: 'conda'}) conda install -c conda-forge spacy +qs({package: 'source'}) git clone https://github.com/explosion/spaCy +qs({package: 'source'}) cd spaCy @@ -80,6 +85,39 @@ p | #[+a("https://github.com/conda-forge/spacy-feedstock") this repository]. | Improvements and pull requests to the recipe and setup are always appreciated. ++h(2, "gpu") Run spaCy with GPU + +p + | As of v2.0, spaCy's comes with neural network models that are implemented + | in our machine learning library, #[+a(gh("thinc")) Thinc]. For GPU + | support, we've been grateful to use the work of + | #[+a("http://chainer.org") Chainer]'s CuPy module, which provides + | a NumPy-compatible interface for GPU arrays. + ++aside("Why is this so complicated?") + | Installing Chainer when no GPU is available currently causes an + | error. We therefore do not specify Chainer as a dependency. However, + | CuPy will be split out into + | #[+a("https://www.slideshare.net/beam2d/chainer-v2-alpha/7") its own package] + | in Chainer v2.0. We'll have a smoother installation process for this + | in an upcoming version. + +p + | First, install follows the normal CUDA installation procedure. Next, set + | your environment variables so that the installation will be able to find + | CUDA. Next, install Chainer, and check that CuPy can be imported + | correctly. Finally, install spaCy. + ++code(false, "bash"). + export CUDA_HOME=/usr/local/cuda-8.0 # Or wherever your CUDA is + export PATH=$PATH:$CUDA_HOME/bin + + pip install chainer + python -c "import cupy; assert cupy" # Check it installed + + pip install spacy + python -c "import thinc.neural.gpu_ops" # Check the GPU ops were built + +h(2, "source") Compile from source p diff --git a/website/docs/usage/v2.jade b/website/docs/usage/v2.jade index 90e46e523..c28863d6c 100644 --- a/website/docs/usage/v2.jade +++ b/website/docs/usage/v2.jade @@ -168,10 +168,17 @@ p python -m spacy download es # default Spanish model python -m spacy download xx_ent_web_md # multi-language NER +p + | spaCy v2.0 comes with new and improved neural network models for English, + | German, French and Spanish, as well as a multi-language named entity + | recognition model trained on Wikipedia. #[strong GPU usage] is now + | supported via #[+a("http://chainer.org") Chainer]'s CuPy module. + +infobox - | #[strong Details:] #[+src(gh("spacy-models")) spacy-models] - | #[+a("/docs/api/language-models") Languages] - | #[strong Usage:] #[+a("/docs/usage/models") Models] + | #[strong Details:] #[+a("/docs/api/language-models") Languages], + | #[+src(gh("spacy-models")) spacy-models] + | #[strong Usage:] #[+a("/docs/usage/models") Models], + | #[+a("/docs/usage#gpu") Using spaCy with GPU] +h(2, "incompat") Backwards incompatibilities