2018-12-02 03:22:23 +00:00
< a href = "https://explosion.ai" > < img src = "https://explosion.ai/assets/img/logo.svg" width = "125" height = "125" align = "right" / > < / a >
2018-11-26 21:04:35 +00:00
# spaCy: Industrial-strength NLP
2021-01-29 09:58:06 +00:00
spaCy is a library for **advanced Natural Language Processing** in Python and
2019-10-02 08:37:04 +00:00
Cython. It's built on the very latest research, and was designed from day one to
2020-09-14 08:29:06 +00:00
be used in real products.
2023-07-24 08:41:04 +00:00
spaCy comes with [pretrained pipelines ](https://spacy.io/models ) and currently
supports tokenization and training for **70+ languages** . It features
state-of-the-art speed and **neural network models** for tagging, parsing,
**named entity recognition**, **text classification** and more, multi-task
learning with pretrained **transformers** like BERT, as well as a
2021-01-31 01:36:04 +00:00
production-ready [**training system** ](https://spacy.io/usage/training ) and easy
model packaging, deployment and workflow management. spaCy is commercial
2023-07-24 08:41:04 +00:00
open-source software, released under the
[MIT license ](https://github.com/explosion/spaCy/blob/master/LICENSE ).
2018-11-26 21:04:35 +00:00
2023-07-24 08:41:04 +00:00
💫 **Version 3.6 out now!**
2019-10-02 14:47:10 +00:00
[Check out the release notes here. ](https://github.com/explosion/spaCy/releases )
2023-07-24 08:41:04 +00:00
[](https://github.com/explosion/spaCy/actions/workflows/tests.yml)
2019-10-02 14:47:10 +00:00
[](https://github.com/explosion/spaCy/releases)
[](https://pypi.org/project/spacy/)
[](https://anaconda.org/conda-forge/spacy)
2018-11-26 21:04:35 +00:00
[](https://github.com/explosion/wheelwright/releases)
2021-01-29 09:55:53 +00:00
[](https://github.com/ambv/black)
2021-01-29 10:05:03 +00:00
< br / >
2021-02-03 01:48:25 +00:00
[](https://pypi.org/project/spacy/)
[](https://anaconda.org/conda-forge/spacy)
2018-11-26 21:04:35 +00:00
[](https://twitter.com/spacy_io)
## 📖 Documentation
2023-07-24 08:41:04 +00:00
| Documentation | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ⭐️ ** [spaCy 101]** | New to spaCy? Here's everything you need to know! |
| 📚 ** [Usage Guides]** | How to use spaCy and its features. |
| 🚀 ** [New in v3.0]** | New features, backwards incompatibilities and migration guide. |
| 🪐 ** [Project Templates]** | End-to-end workflows you can clone, modify and run. |
| 🎛 ** [API Reference]** | The detailed reference for spaCy's API. |
| 📦 ** [Models]** | Download trained pipelines for spaCy. |
| 🌌 ** [Universe]** | Plugins, extensions, demos and books from the spaCy ecosystem. |
| ⚙️ ** [spaCy VS Code Extension]** | Additional tooling and features for working with spaCy's config files. |
| 👩🏫 ** [Online Course]** | Learn spaCy in this free and interactive online course. |
| 📺 ** [Videos]** | Our YouTube channel with video tutorials, talks and more. |
| 🛠 ** [Changelog]** | Changes and version history. |
| 💝 ** [Contribute]** | How to contribute to the spaCy project and code base. |
| < a href = "https://explosion.ai/spacy-tailored-pipelines" >< img src = "https://user-images.githubusercontent.com/13643239/152853098-1c761611-ccb0-4ec6-9066-b234552831fe.png" width = "125" alt = "spaCy Tailored Pipelines" /></ a > | Get a custom spaCy pipeline, tailor-made for your NLP problem by spaCy's core developers. Streamlined, production-ready, predictable and maintainable. Start by completing our 5-minute questionnaire to tell us what you need and we'll be in touch! ** [Learn more → ](https://explosion.ai/spacy-tailored-pipelines )** |
| < a href = "https://explosion.ai/spacy-tailored-analysis" >< img src = "https://user-images.githubusercontent.com/1019791/206151300-b00cd189-e503-4797-aa1e-1bb6344062c5.png" width = "125" alt = "spaCy Tailored Pipelines" /></ a > | Bespoke advice for problem solving, strategy and analysis for applied NLP projects. Services include data strategy, code reviews, pipeline design and annotation coaching. Curious? Fill in our 5-minute questionnaire to tell us what you need and we'll be in touch! ** [Learn more → ](https://explosion.ai/spacy-tailored-analysis )** |
2019-02-24 12:12:13 +00:00
[spacy 101]: https://spacy.io/usage/spacy-101
2020-09-14 08:29:06 +00:00
[new in v3.0]: https://spacy.io/usage/v3
2019-02-24 12:12:13 +00:00
[usage guides]: https://spacy.io/usage/
[api reference]: https://spacy.io/api/
[models]: https://spacy.io/models
[universe]: https://spacy.io/universe
2023-07-24 08:41:04 +00:00
[spacy vs code extension]: https://github.com/explosion/spacy-vscode
2021-01-29 10:08:51 +00:00
[videos]: https://www.youtube.com/c/ExplosionAI
2021-01-29 10:05:03 +00:00
[online course]: https://course.spacy.io
2020-09-23 07:45:32 +00:00
[project templates]: https://github.com/explosion/projects
2019-04-02 15:36:22 +00:00
[changelog]: https://spacy.io/usage#changelog
2019-02-24 12:12:13 +00:00
[contribute]: https://github.com/explosion/spaCy/blob/master/CONTRIBUTING.md
2018-11-26 21:04:35 +00:00
## 💬 Where to ask questions
2022-02-08 10:46:42 +00:00
The spaCy project is maintained by the [spaCy team ](https://explosion.ai/about ).
2021-06-24 02:37:55 +00:00
Please understand that we won't be able to provide individual support via email.
We also believe that help is much more valuable if it's shared publicly, so that
more people can benefit from it.
2018-11-26 21:04:35 +00:00
2020-12-10 23:05:19 +00:00
| Type | Platforms |
| ------------------------------- | --------------------------------------- |
| 🚨 **Bug Reports** | [GitHub Issue Tracker] |
| 🎁 **Feature Requests & Ideas** | [GitHub Discussions] |
| 👩💻 **Usage Questions** | [GitHub Discussions] · [Stack Overflow] |
| 🗯 **General Discussion** | [GitHub Discussions] |
2018-11-26 21:04:35 +00:00
2019-02-24 12:12:13 +00:00
[github issue tracker]: https://github.com/explosion/spaCy/issues
2020-12-10 18:58:43 +00:00
[github discussions]: https://github.com/explosion/spaCy/discussions
2019-04-02 15:36:22 +00:00
[stack overflow]: https://stackoverflow.com/questions/tagged/spacy
2018-11-26 21:04:35 +00:00
## Features
2022-10-25 12:54:54 +00:00
- Support for **70+ languages**
2021-01-29 09:55:53 +00:00
- **Trained pipelines** for different languages and tasks
2020-09-14 08:29:06 +00:00
- Multi-task learning with pretrained **transformers** like BERT
2021-01-31 01:36:04 +00:00
- Support for pretrained **word vectors** and embeddings
2019-11-14 23:33:44 +00:00
- State-of-the-art speed
2020-09-14 08:29:06 +00:00
- Production-ready **training system**
- Linguistically-motivated **tokenization**
2023-07-24 08:41:04 +00:00
- Components for named **entity recognition** , part-of-speech-tagging,
dependency parsing, sentence segmentation, **text classification** ,
lemmatization, morphological analysis, entity linking and more
2020-09-14 08:29:06 +00:00
- Easily extensible with **custom components** and attributes
- Support for custom models in **PyTorch** , **TensorFlow** and other frameworks
2019-11-14 23:33:44 +00:00
- Built in **visualizers** for syntax and NER
2020-09-14 08:29:06 +00:00
- Easy **model packaging** , deployment and workflow management
2019-11-14 23:33:44 +00:00
- Robust, rigorously evaluated accuracy
2019-02-24 12:12:13 +00:00
📖 **For more details, see the
2018-11-26 21:04:35 +00:00
[facts, figures and benchmarks ](https://spacy.io/usage/facts-figures ).**
2021-01-31 01:36:04 +00:00
## ⏳ Install spaCy
2018-11-26 21:04:35 +00:00
For detailed installation instructions, see the
[documentation ](https://spacy.io/usage ).
2019-11-14 23:33:44 +00:00
- **Operating system**: macOS / OS X · Linux · Windows (Cygwin, MinGW, Visual
Studio)
2023-09-25 12:48:38 +00:00
- **Python version**: Python 3.7+ (only 64 bit)
2019-11-14 23:33:44 +00:00
- **Package managers**: [pip] · [conda] (via `conda-forge` )
2018-11-26 21:04:35 +00:00
2019-04-02 15:36:22 +00:00
[pip]: https://pypi.org/project/spacy/
2018-11-26 21:04:35 +00:00
[conda]: https://anaconda.org/conda-forge/spacy
### pip
2021-01-31 01:36:04 +00:00
Using pip, spaCy releases are available as source packages and binary wheels.
2023-07-24 08:41:04 +00:00
Before you install spaCy and its dependencies, make sure that your `pip` ,
`setuptools` and `wheel` are up to date.
2018-11-26 21:04:35 +00:00
```bash
2020-10-06 08:40:43 +00:00
pip install -U pip setuptools wheel
2018-11-26 21:04:35 +00:00
pip install spacy
```
2021-01-31 01:36:04 +00:00
To install additional data tables for lemmatization and normalization you can
run `pip install spacy[lookups]` or install
2019-10-02 14:47:10 +00:00
[`spacy-lookups-data` ](https://github.com/explosion/spacy-lookups-data )
separately. The lookups package is needed to create blank models with
2021-01-31 01:36:04 +00:00
lemmatization data, and to lemmatize in languages that don't yet come with
pretrained models and aren't powered by third-party libraries.
2019-10-02 14:47:10 +00:00
2018-11-26 21:04:35 +00:00
When using pip it is generally recommended to install packages in a virtual
environment to avoid modifying system state:
```bash
python -m venv .env
source .env/bin/activate
2020-12-10 14:34:34 +00:00
pip install -U pip setuptools wheel
2018-11-26 21:04:35 +00:00
pip install spacy
```
### conda
2021-01-31 01:36:04 +00:00
You can also install spaCy from `conda` via the `conda-forge` channel. For the
feedstock including the build recipe and configuration, check out
[this repository ](https://github.com/conda-forge/spacy-feedstock ).
2018-11-26 21:04:35 +00:00
```bash
2019-10-31 12:23:25 +00:00
conda install -c conda-forge spacy
2018-11-26 21:04:35 +00:00
```
### Updating spaCy
Some updates to spaCy may require downloading new statistical models. If you're
running spaCy v2.0 or higher, you can use the `validate` command to check if
your installed models are compatible and if not, print details on how to update
them:
```bash
pip install -U spacy
python -m spacy validate
```
If you've trained your own models, keep in mind that your training and runtime
inputs must match. After updating spaCy, we recommend **retraining your models**
with the new version.
2020-09-14 08:29:06 +00:00
📖 **For details on upgrading from spaCy 2.x to spaCy 3.x, see the
[migration guide ](https://spacy.io/usage/v3#migrating ).**
2018-11-26 21:04:35 +00:00
2021-01-31 01:36:04 +00:00
## 📦 Download model packages
2018-11-26 21:04:35 +00:00
2023-07-24 08:41:04 +00:00
Trained pipelines for spaCy can be installed as **Python packages** . This means
that they're a component of your application, just like any other module. Models
can be installed using spaCy's [`download` ](https://spacy.io/api/cli#download )
2021-01-31 01:36:04 +00:00
command, or manually by pointing pip to a path or URL.
2018-11-26 21:04:35 +00:00
2021-01-31 01:36:04 +00:00
| Documentation | |
| -------------------------- | ---------------------------------------------------------------- |
| ** [Available Pipelines]** | Detailed pipeline descriptions, accuracy figures and benchmarks. |
| ** [Models Documentation]** | Detailed usage and installation instructions. |
| ** [Training]** | How to train your own pipelines on your data. |
2018-11-26 21:04:35 +00:00
2020-09-14 08:29:06 +00:00
[available pipelines]: https://spacy.io/models
2021-01-31 01:36:04 +00:00
[models documentation]: https://spacy.io/usage/models
[training]: https://spacy.io/usage/training
2018-11-26 21:04:35 +00:00
```bash
2020-09-14 08:29:06 +00:00
# Download best-matching version of specific model for your spaCy installation
2019-03-17 10:48:18 +00:00
python -m spacy download en_core_web_sm
2021-02-01 12:18:43 +00:00
# pip install .tar.gz archive or .whl from path or URL
2021-01-31 01:36:04 +00:00
pip install /Users/you/en_core_web_sm-3.0.0.tar.gz
2021-02-01 12:18:43 +00:00
pip install /Users/you/en_core_web_sm-3.0.0-py3-none-any.whl
2021-01-31 01:36:04 +00:00
pip install https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-3.0.0/en_core_web_sm-3.0.0.tar.gz
2018-11-26 21:04:35 +00:00
```
### Loading and using models
2021-01-31 01:36:04 +00:00
To load a model, use [`spacy.load()` ](https://spacy.io/api/top-level#spacy.load )
with the model name or a path to the model data directory.
2018-11-26 21:04:35 +00:00
```python
import spacy
2019-03-17 10:48:18 +00:00
nlp = spacy.load("en_core_web_sm")
2019-10-18 16:47:59 +00:00
doc = nlp("This is a sentence.")
2018-11-26 21:04:35 +00:00
```
2019-03-17 10:48:18 +00:00
You can also `import` a model directly via its full name and then call its
`load()` method with no arguments.
2018-11-26 21:04:35 +00:00
```python
import spacy
import en_core_web_sm
nlp = en_core_web_sm.load()
2019-10-18 16:47:59 +00:00
doc = nlp("This is a sentence.")
2018-11-26 21:04:35 +00:00
```
📖 **For more info and examples, check out the
[models documentation ](https://spacy.io/docs/usage/models ).**
2021-01-31 01:36:04 +00:00
## ⚒ Compile from source
2018-11-26 21:04:35 +00:00
The other way to install spaCy is to clone its
[GitHub repository ](https://github.com/explosion/spaCy ) and build it from
source. That is the common way if you want to make changes to the code base.
You'll need to make sure that you have a development environment consisting of a
Python distribution including header files, a compiler,
[pip ](https://pip.pypa.io/en/latest/installing/ ),
2019-10-02 08:37:04 +00:00
[virtualenv ](https://virtualenv.pypa.io/en/latest/ ) and
[git ](https://git-scm.com ) installed. The compiler part is the trickiest. How to
2021-01-31 01:36:04 +00:00
do that depends on your system.
2021-01-31 01:37:13 +00:00
| Platform | |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Ubuntu** | Install system-level dependencies via `apt-get` : `sudo apt-get install build-essential python-dev git` . |
| **Mac** | Install a recent version of [XCode ](https://developer.apple.com/xcode/ ), including the so-called "Command Line Tools". macOS and OS X ship with Python and git preinstalled. |
| **Windows** | Install a version of the [Visual C++ Build Tools ](https://visualstudio.microsoft.com/visual-cpp-build-tools/ ) or [Visual Studio Express ](https://visualstudio.microsoft.com/vs/express/ ) that matches the version that was used to compile your Python interpreter. |
2021-01-31 01:36:04 +00:00
2023-07-24 08:41:04 +00:00
For more details and instructions, see the documentation on
2021-01-31 01:36:04 +00:00
[compiling spaCy from source ](https://spacy.io/usage#source ) and the
[quickstart widget ](https://spacy.io/usage#section-quickstart ) to get the right
commands for your platform and Python version.
2018-11-26 21:04:35 +00:00
```bash
git clone https://github.com/explosion/spaCy
cd spaCy
python -m venv .env
source .env/bin/activate
2020-12-10 14:34:34 +00:00
# make sure you are using the latest pip
python -m pip install -U pip setuptools wheel
2021-02-02 15:51:27 +00:00
pip install -r requirements.txt
pip install --no-build-isolation --editable .
2020-12-10 14:34:34 +00:00
```
To install with extras:
```bash
2021-02-02 15:51:27 +00:00
pip install --no-build-isolation --editable .[lookups,cuda102]
2018-11-26 21:04:35 +00:00
```
2021-01-31 01:36:04 +00:00
## 🚦 Run tests
2018-11-26 21:04:35 +00:00
2019-09-29 15:32:12 +00:00
spaCy comes with an [extensive test suite ](spacy/tests ). In order to run the
2018-11-26 21:04:35 +00:00
tests, you'll usually want to clone the repository and build spaCy from source.
This will also install the required development dependencies and test utilities
2021-01-31 01:36:04 +00:00
defined in the [`requirements.txt` ](requirements.txt ).
2018-11-26 21:04:35 +00:00
2020-12-10 14:34:34 +00:00
Alternatively, you can run `pytest` on the tests from within the installed
`spacy` package. Don't forget to also install the test utilities via spaCy's
2021-01-31 01:36:04 +00:00
[`requirements.txt` ](requirements.txt ):
2018-11-26 21:04:35 +00:00
```bash
2020-12-10 14:34:34 +00:00
pip install -r requirements.txt
python -m pytest --pyargs spacy
2018-11-26 21:04:35 +00:00
```
