spaCy/README.rst

333 lines
12 KiB
ReStructuredText
Raw Normal View History

2015-07-01 16:39:38 +03:00
spaCy: Industrial-strength NLP
2016-10-03 13:33:22 +03:00
******************************
2014-07-03 19:15:40 +04:00
2017-11-08 00:41:54 +03:00
spaCy is a library for advanced Natural Language Processing in Python and Cython.
It's built on the very latest research, and was designed from day one to be
used in real products. spaCy comes with
`pre-trained statistical models <https://spacy.io/models>`_ and word
vectors, and currently supports tokenization for **20+ languages**. It features
the **fastest syntactic parser** in the world, convolutional **neural network models**
for tagging, parsing and **named entity recognition** and easy **deep learning**
integration. It's commercial open-source software, released under the MIT license.
2017-04-07 20:30:49 +03:00
2017-11-08 00:41:54 +03:00
💫 **Version 2.0 out now!** `Check out the new features here. <https://spacy.io/usage/v2>`_
2016-10-19 03:32:08 +03:00
2018-04-11 00:05:49 +03:00
.. image:: https://img.shields.io/travis/explosion/spaCy/master.svg?style=flat-square&logo=travis
2016-10-16 00:51:16 +03:00
:target: https://travis-ci.org/explosion/spaCy
2017-11-08 00:41:54 +03:00
:alt: Build Status
2018-04-11 00:05:49 +03:00
.. image:: https://img.shields.io/appveyor/ci/explosion/spaCy/master.svg?style=flat-square&logo=appveyor
2017-11-22 06:20:32 +03:00
:target: https://ci.appveyor.com/project/explosion/spaCy
:alt: Appveyor Build Status
.. image:: https://img.shields.io/github/release/explosion/spacy.svg?style=flat-square
:target: https://github.com/explosion/spaCy/releases
:alt: Current Release Version
2017-03-07 19:59:30 +03:00
.. image:: https://img.shields.io/pypi/v/spacy.svg?style=flat-square
:target: https://pypi.python.org/pypi/spacy
:alt: pypi Version
2018-04-11 00:05:49 +03:00
.. image:: https://img.shields.io/conda/vn/conda-forge/spacy.svg?style=flat-square
:target: https://anaconda.org/conda-forge/spacy
:alt: conda Version
2018-04-11 00:05:49 +03:00
.. image:: https://img.shields.io/badge/chat-join%20%E2%86%92-09a3d5.svg?style=flat-square&logo=gitter-white
2016-10-16 22:53:24 +03:00
:target: https://gitter.im/explosion/spaCy
:alt: spaCy on Gitter
.. image:: https://img.shields.io/twitter/follow/spacy_io.svg?style=social&label=Follow
2017-01-14 21:02:05 +03:00
:target: https://twitter.com/spacy_io
:alt: spaCy on Twitter
2015-06-24 06:05:33 +03:00
2016-11-01 01:29:57 +03:00
📖 Documentation
2016-11-05 04:35:37 +03:00
================
2016-11-01 01:29:57 +03:00
2017-11-08 00:41:54 +03:00
=================== ===
`spaCy 101`_ New to spaCy? Here's everything you need to know!
`Usage Guides`_ How to use spaCy and its features.
`New in v2.0`_ New features, backwards incompatibilities and migration guide.
`API Reference`_ The detailed reference for spaCy's API.
`Models`_ Download statistical language models for spaCy.
💫 Interactive code examples, spaCy Universe and various docs improvements (#2274) * Integrate Python kernel via Binder * Add live model test for languages with examples * Update docs and code examples * Adjust margin (if not bootstrapped) * Add binder version to global config * Update terminal and executable code mixins * Pass attributes through infobox and section * Hide v-cloak * Fix example * Take out model comparison for now * Add meta text for compat * Remove chart.js dependency * Tidy up and simplify JS and port big components over to Vue * Remove chartjs example * Add Twitter icon * Add purple stylesheet option * Add utility for hand cursor (special cases only) * Add transition classes * Add small option for section * Add thumb object for small round thumbnail images * Allow unset code block language via "none" value (workaround to still allow unset language to default to DEFAULT_SYNTAX) * Pass through attributes * Add syntax highlighting definitions for Julia, R and Docker * Add website icon * Remove user survey from navigation * Don't hide GitHub icon on small screens * Make top navigation scrollable on small screens * Remove old resources page and references to it * Add Universe * Add helper functions for better page URL and title * Update site description * Increment versions * Update preview images * Update mentions of resources * Fix image * Fix social images * Fix problem with cover sizing and floats * Add divider and move badges into heading * Add docstrings * Reference converting section * Add section on converting word vectors * Move converting section to custom section and fix formatting * Remove old fastText example * Move extensions content to own section Keep weird ID to not break permalinks for now (we don't want to rewrite URLs if not absolutely necessary) * Use better component example and add factories section * Add note on larger model * Use better example for non-vector * Remove similarity in context section Only works via small models with tensors so has always been kind of confusing * Add note on init-model command * Fix lightning tour examples and make excutable if possible * Add spacy train CLI section to train * Fix formatting and add video * Fix formatting * Fix textcat example description (resolves #2246) * Add dummy file to try resolve conflict * Delete dummy file * Tidy up [ci skip] * Ensure sufficient height of loading container * Add loading animation to universe * Update Thebelab build and use better startup message * Fix asset versioning * Fix typo [ci skip] * Add note on project idea label
2018-04-29 03:06:46 +03:00
`Universe`_ Libraries, extensions, demos, books and courses.
2017-11-08 00:41:54 +03:00
`Changelog`_ Changes and version history.
`Contribute`_ How to contribute to the spaCy project and code base.
=================== ===
.. _spaCy 101: https://spacy.io/usage/spacy-101
.. _New in v2.0: https://spacy.io/usage/v2#migrating
.. _Usage Guides: https://spacy.io/usage/
.. _API Reference: https://spacy.io/api/
.. _Models: https://spacy.io/models
💫 Interactive code examples, spaCy Universe and various docs improvements (#2274) * Integrate Python kernel via Binder * Add live model test for languages with examples * Update docs and code examples * Adjust margin (if not bootstrapped) * Add binder version to global config * Update terminal and executable code mixins * Pass attributes through infobox and section * Hide v-cloak * Fix example * Take out model comparison for now * Add meta text for compat * Remove chart.js dependency * Tidy up and simplify JS and port big components over to Vue * Remove chartjs example * Add Twitter icon * Add purple stylesheet option * Add utility for hand cursor (special cases only) * Add transition classes * Add small option for section * Add thumb object for small round thumbnail images * Allow unset code block language via "none" value (workaround to still allow unset language to default to DEFAULT_SYNTAX) * Pass through attributes * Add syntax highlighting definitions for Julia, R and Docker * Add website icon * Remove user survey from navigation * Don't hide GitHub icon on small screens * Make top navigation scrollable on small screens * Remove old resources page and references to it * Add Universe * Add helper functions for better page URL and title * Update site description * Increment versions * Update preview images * Update mentions of resources * Fix image * Fix social images * Fix problem with cover sizing and floats * Add divider and move badges into heading * Add docstrings * Reference converting section * Add section on converting word vectors * Move converting section to custom section and fix formatting * Remove old fastText example * Move extensions content to own section Keep weird ID to not break permalinks for now (we don't want to rewrite URLs if not absolutely necessary) * Use better component example and add factories section * Add note on larger model * Use better example for non-vector * Remove similarity in context section Only works via small models with tensors so has always been kind of confusing * Add note on init-model command * Fix lightning tour examples and make excutable if possible * Add spacy train CLI section to train * Fix formatting and add video * Fix formatting * Fix textcat example description (resolves #2246) * Add dummy file to try resolve conflict * Delete dummy file * Tidy up [ci skip] * Ensure sufficient height of loading container * Add loading animation to universe * Update Thebelab build and use better startup message * Fix asset versioning * Fix typo [ci skip] * Add note on project idea label
2018-04-29 03:06:46 +03:00
.. _Universe: https://spacy.io/universe
2017-11-08 00:41:54 +03:00
.. _Changelog: https://spacy.io/usage/#changelog
2017-03-12 22:00:41 +03:00
.. _Contribute: https://github.com/explosion/spaCy/blob/master/CONTRIBUTING.md
2016-11-01 01:29:57 +03:00
💬 Where to ask questions
==========================
2017-11-08 00:41:54 +03:00
The spaCy project is maintained by `@honnibal <https://github.com/honnibal>`_
and `@ines <https://github.com/ines>`_. 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.
2017-10-24 22:39:18 +03:00
2017-03-12 22:00:41 +03:00
====================== ===
2017-11-08 00:41:54 +03:00
**Bug Reports** `GitHub Issue Tracker`_
**Usage Questions** `StackOverflow`_, `Gitter Chat`_, `Reddit User Group`_
**General Discussion** `Gitter Chat`_, `Reddit User Group`_
2017-03-12 22:00:41 +03:00
====================== ===
2017-11-08 00:41:54 +03:00
.. _GitHub Issue Tracker: https://github.com/explosion/spaCy/issues
2017-03-12 22:00:41 +03:00
.. _StackOverflow: http://stackoverflow.com/questions/tagged/spacy
2017-11-08 00:41:54 +03:00
.. _Gitter Chat: https://gitter.im/explosion/spaCy
.. _Reddit User Group: https://www.reddit.com/r/spacynlp
Features
2016-10-03 13:33:22 +03:00
========
2017-11-08 00:41:54 +03:00
* **Fastest syntactic parser** in the world
* **Named entity** recognition
* Non-destructive **tokenization**
2017-11-08 00:41:54 +03:00
* Support for **20+ languages**
* Pre-trained `statistical models <https://spacy.io/models>`_ and word vectors
* Easy **deep learning** integration
* Part-of-speech tagging
* Labelled dependency parsing
2017-11-08 00:41:54 +03:00
* Syntax-driven sentence segmentation
* Built in **visualizers** for syntax and NER
* Convenient string-to-hash mapping
* Export to numpy data arrays
* Efficient binary serialization
2017-11-08 00:41:54 +03:00
* Easy **model packaging** and deployment
* State-of-the-art speed
* Robust, rigorously evaluated accuracy
2017-11-08 00:41:54 +03:00
📖 **For more details, see the** `facts, figures and benchmarks <https://spacy.io/usage/facts-figures>`_.
2017-11-08 00:41:54 +03:00
Install spaCy
=============
2017-11-07 22:45:34 +03:00
2017-11-08 00:41:54 +03:00
For detailed installation instructions, see
the `documentation <https://spacy.io/usage>`_.
2017-03-12 22:00:41 +03:00
==================== ===
**Operating system** macOS / OS X, Linux, Windows (Cygwin, MinGW, Visual Studio)
**Python version** CPython 2.7, 3.4+. Only 64 bit.
2017-03-12 22:00:41 +03:00
**Package managers** `pip`_ (source packages only), `conda`_ (via ``conda-forge``)
==================== ===
2017-03-12 22:00:41 +03:00
.. _pip: https://pypi.python.org/pypi/spacy
.. _conda: https://anaconda.org/conda-forge/spacy
2016-10-03 13:33:22 +03:00
pip
---
Using pip, spaCy releases are currently only available as source packages.
2016-10-03 13:33:22 +03:00
.. code:: bash
2017-11-08 00:41:54 +03:00
pip install spacy
2016-10-03 13:33:22 +03:00
2017-11-08 00:41:54 +03:00
When using pip it is generally recommended to install packages in a virtual
environment to avoid modifying system state:
.. code:: bash
python -m venv .env
source .env/bin/activate
pip install spacy
2016-10-03 13:33:22 +03:00
conda
-----
Thanks to our great community, we've finally re-added conda support. You can now
install spaCy via ``conda-forge``:
.. code:: bash
2017-11-08 00:41:54 +03:00
  conda config --add channels conda-forge
  conda install spacy
For the feedstock including the build recipe and configuration,
check out `this repository <https://github.com/conda-forge/spacy-feedstock>`_.
Improvements and pull requests to the recipe and setup are always appreciated.
2017-11-08 00:41:54 +03: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:
.. code:: bash
pip install -U spacy
python -m spacy validate
2017-11-08 00:41:54 +03:00
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.
📖 **For details on upgrading from spaCy 1.x to spaCy 2.x, see the**
`migration guide <https://spacy.io/usage/v2#migrating>`_.
Download models
===============
2016-10-03 13:33:22 +03:00
2017-03-18 19:56:05 +03:00
As of v1.7.0, models for spaCy can be installed as **Python packages**.
This means that they're a component of your application, just like any
2017-11-08 00:41:54 +03:00
other module. Models can be installed using spaCy's ``download`` command,
or manually by pointing pip to a path or URL.
2017-03-18 19:56:05 +03:00
======================= ===
2017-11-08 00:41:54 +03:00
`Available Models`_ Detailed model descriptions, accuracy figures and benchmarks.
2017-03-18 19:56:05 +03:00
`Models Documentation`_ Detailed usage instructions.
======================= ===
2017-11-08 00:41:54 +03:00
.. _Available Models: https://spacy.io/models
2017-11-07 14:00:43 +03:00
.. _Models Documentation: https://spacy.io/docs/usage/models
2016-10-03 13:33:22 +03:00
.. code:: bash
2017-03-18 19:56:05 +03:00
# out-of-the-box: download best-matching default model
python -m spacy download en
2016-10-03 13:33:22 +03:00
2017-03-18 19:56:05 +03:00
# download best-matching version of specific model for your spaCy installation
2017-11-08 00:41:54 +03:00
python -m spacy download en_core_web_lg
2016-10-03 13:33:22 +03:00
2017-03-18 19:56:05 +03:00
# pip install .tar.gz archive from path or URL
2017-11-08 00:41:54 +03:00
pip install /Users/you/en_core_web_sm-2.0.0.tar.gz
2016-10-03 13:33:22 +03:00
If you have SSL certification problems, SSL customization options are described in the help:
# help for the download command
python -m spacy download --help
2017-03-18 19:56:05 +03:00
Loading and using models
------------------------
2016-10-03 13:33:22 +03:00
2017-03-18 19:56:05 +03:00
To load a model, use ``spacy.load()`` with the model's shortcut link:
2016-10-03 13:33:22 +03:00
2017-03-18 19:56:05 +03:00
.. code:: python
2017-03-17 21:55:55 +03:00
2017-03-18 19:56:05 +03:00
import spacy
2017-11-08 00:41:54 +03:00
nlp = spacy.load('en')
2017-03-18 19:56:05 +03:00
doc = nlp(u'This is a sentence.')
2017-03-17 21:55:55 +03:00
2017-03-18 19:56:05 +03:00
If you've installed a model via pip, you can also ``import`` it directly and
2017-11-08 00:41:54 +03:00
then call its ``load()`` method:
2017-03-17 21:55:55 +03:00
2017-03-18 19:56:05 +03:00
.. code:: python
import spacy
2017-11-08 00:41:54 +03:00
import en_core_web_sm
2017-03-18 19:56:05 +03:00
nlp = en_core_web_sm.load()
2017-03-18 19:56:05 +03:00
doc = nlp(u'This is a sentence.')
2017-11-08 00:41:54 +03:00
📖 **For more info and examples, check out the**
`models documentation <https://spacy.io/docs/usage/models>`_.
2016-10-03 13:33:22 +03:00
2017-03-18 19:56:05 +03:00
Support for older versions
--------------------------
2017-11-08 00:41:54 +03:00
If you're using an older version (``v1.6.0`` or below), you can still download
and install the old models from within spaCy using ``python -m spacy.en.download all``
2017-03-18 19:56:05 +03:00
or ``python -m spacy.de.download all``. The ``.tar.gz`` archives are also
`attached to the v1.6.0 release <https://github.com/explosion/spaCy/tree/v1.6.0>`_.
To download and install the models manually, unpack the archive, drop the
contained directory into ``spacy/data`` and load the model via ``spacy.load('en')``
or ``spacy.load('de')``.
2016-10-03 13:33:22 +03:00
Compile from source
===================
The other way to install spaCy is to clone its
`GitHub repository <https://github.com/explosion/spaCy>`_ and build it from
2016-10-03 13:33:22 +03:00
source. That is the common way if you want to make changes to the code base.
2017-11-08 00:41:54 +03:00
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/>`__, `virtualenv <https://virtualenv.pypa.io/>`_
and `git <https://git-scm.com>`_ installed. The compiler part is the trickiest.
How to do that depends on your system. See notes on Ubuntu, OS X and Windows for
details.
2016-10-03 13:33:22 +03:00
.. code:: bash
# make sure you are using the latest pip
python -m pip install -U pip
2017-03-08 13:37:04 +03:00
git clone https://github.com/explosion/spaCy
2016-10-03 13:33:22 +03:00
cd spaCy
python -m venv .env
source .env/bin/activate
2017-11-08 00:41:54 +03:00
export PYTHONPATH=`pwd`
2016-10-03 13:33:22 +03:00
pip install -r requirements.txt
2017-11-08 00:41:54 +03:00
python setup.py build_ext --inplace
2017-11-08 00:41:54 +03:00
Compared to regular install via pip, `requirements.txt <requirements.txt>`_
additionally installs developer dependencies such as Cython. For more details
and instructions, see the documentation on
`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.
Instead of the above verbose commands, you can also use the following
2017-11-08 00:41:54 +03:00
`Fabric <http://www.fabfile.org/>`_ commands. All commands assume that your
virtual environment is located in a directory ``.env``. If you're using a
different directory, you can change it via the environment variable ``VENV_DIR``,
for example ``VENV_DIR=".custom-env" fab clean make``.
2017-03-12 22:03:15 +03:00
============= ===
2017-11-08 00:41:54 +03:00
``fab env`` Create virtual environment and delete previous one, if it exists.
2017-03-12 22:03:15 +03:00
``fab make`` Compile the source.
``fab clean`` Remove compiled objects, including the generated C++.
``fab test`` Run basic tests, aborting after first failure.
============= ===
2016-10-03 13:33:22 +03:00
Ubuntu
------
Install system-level dependencies via ``apt-get``:
.. code:: bash
sudo apt-get install build-essential python-dev git
2016-11-01 01:36:34 +03:00
macOS / OS X
------------
2016-10-03 13:33:22 +03:00
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
2016-11-01 01:36:34 +03:00
and git preinstalled.
2016-10-03 13:33:22 +03:00
Windows
-------
2016-11-01 01:36:34 +03:00
Install a version of `Visual Studio Express <https://www.visualstudio.com/vs/visual-studio-express/>`_
or higher that matches the version that was used to compile your Python
interpreter. For official distributions these are VS 2008 (Python 2.7),
2016-11-01 01:36:34 +03:00
VS 2010 (Python 3.4) and VS 2015 (Python 3.5).
2016-10-03 13:33:22 +03:00
Run tests
=========
spaCy comes with an `extensive test suite <spacy/tests>`_. In order to run the
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
defined in the ``requirements.txt``.
2016-10-03 13:33:22 +03:00
Alternatively, you can find out where spaCy is installed and run ``pytest`` on
that directory. Don't forget to also install the test utilities via spaCy's
``requirements.txt``:
2016-10-03 13:33:22 +03:00
.. code:: bash
python -c "import os; import spacy; print(os.path.dirname(spacy.__file__))"
pip install -r path/to/requirements.txt
2017-11-08 00:41:54 +03:00
python -m pytest <spacy-directory>
See `the documentation <https://spacy.io/usage/#tests>`_ for more details and
examples.