explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2024-11-14 05:37:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Auto-format

Browse Source
This commit is contained in:
Ines Montani 2019-10-02 10:37:04 +02:00
parent 867e93aae2
commit 208629615d
1 changed files with 31 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@ -3,9 +3,9 @@
# spaCy: Industrial-strength NLP # spaCy: Industrial-strength NLP
spaCy is a library for advanced Natural Language Processing in Python and 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 [pre-trained statistical models](https://spacy.io/models) and word vectors, 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
currently supports tokenization for **50+ languages**. It features currently supports tokenization for **50+ languages**. It features
state-of-the-art speed, convolutional **neural network models** for tagging, state-of-the-art speed, convolutional **neural network models** for tagging,
parsing and **named entity recognition** and easy **deep learning** integration. parsing and **named entity recognition** and easy **deep learning** integration.
@ -48,13 +48,13 @@ It's commercial open-source software, released under the MIT license.
## 💬 Where to ask questions ## 💬 Where to ask questions
The spaCy project is maintained by [@honnibal](https://github.com/honnibal) The spaCy project is maintained by [@honnibal](https://github.com/honnibal) and
and [@ines](https://github.com/ines), along with core contributors [@ines](https://github.com/ines), along with core contributors
[@svlandeg](https://github.com/svlandeg) and [@svlandeg](https://github.com/svlandeg) and
[@adrianeboyd](https://github.com/adrianeboyd). Please understand that we won't [@adrianeboyd](https://github.com/adrianeboyd). Please understand that we won't
be able to provide individual support via email. We also believe that help is 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 much more valuable if it's shared publicly, so that more people can benefit from
from it. it.
| Type | Platforms | | Type | Platforms |
| ------------------------ | ------------------------------------------------------ | | ------------------------ | ------------------------------------------------------ |
@ -94,7 +94,8 @@ from it.
For detailed installation instructions, see the For detailed installation instructions, see the
[documentation](https://spacy.io/usage). [documentation](https://spacy.io/usage).
- **Operating system**: macOS / OS X · Linux · Windows (Cygwin, MinGW, Visual Studio) - **Operating system**: macOS / OS X · Linux · Windows (Cygwin, MinGW, Visual
Studio)
- **Python version**: Python 2.7, 3.5+ (only 64 bit) - **Python version**: Python 2.7, 3.5+ (only 64 bit)
- **Package managers**: [pip] · [conda] (via `conda-forge`) - **Package managers**: [pip] · [conda] (via `conda-forge`)
@ -103,8 +104,8 @@ For detailed installation instructions, see the
### pip ### pip
Using pip, spaCy releases are available as source packages and binary wheels Using pip, spaCy releases are available as source packages and binary wheels (as
(as of `v2.0.13`). of `v2.0.13`).
```bash ```bash
pip install spacy pip install spacy
@ -129,9 +130,9 @@ conda config --add channels conda-forge
conda install spacy conda install spacy
``` ```
For the feedstock including the build recipe and configuration, For the feedstock including the build recipe and configuration, check out
check out [this repository](https://github.com/conda-forge/spacy-feedstock). [this repository](https://github.com/conda-forge/spacy-feedstock). Improvements
Improvements and pull requests to the recipe and setup are always appreciated. and pull requests to the recipe and setup are always appreciated.
### Updating spaCy ### Updating spaCy
@ -154,10 +155,10 @@ with the new version.
## Download models ## Download models
As of v1.7.0, models for spaCy can be installed as **Python packages**. As of v1.7.0, models for spaCy can be installed as **Python packages**. This
This means that they're a component of your application, just like any means that they're a component of your application, just like any other module.
other module. Models can be installed using spaCy's `download` command, Models can be installed using spaCy's `download` command, or manually by
or manually by pointing pip to a path or URL. pointing pip to a path or URL.
| Documentation | | | Documentation | |
| ---------------------- | ------------------------------------------------------------- | | ---------------------- | ------------------------------------------------------------- |
@ -206,8 +207,8 @@ doc = nlp(u"This is a sentence.")
### Support for older versions ### Support for older versions
If you're using an older version (`v1.6.0` or below), you can still download If you're using an older version (`v1.6.0` or below), you can still download and
and install the old models from within spaCy using `python -m spacy.en.download all` install the old models from within spaCy using `python -m spacy.en.download all`
or `python -m spacy.de.download all`. The `.tar.gz` archives are also 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). [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 To download and install the models manually, unpack the archive, drop the
@ -222,9 +223,10 @@ 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 You'll need to make sure that you have a development environment consisting of a
Python distribution including header files, a compiler, Python distribution including header files, a compiler,
[pip](https://pip.pypa.io/en/latest/installing/), [pip](https://pip.pypa.io/en/latest/installing/),
[virtualenv](https://virtualenv.pypa.io/en/latest/) and [git](https://git-scm.com) [virtualenv](https://virtualenv.pypa.io/en/latest/) and
installed. The compiler part is the trickiest. How to do that depends on your [git](https://git-scm.com) installed. The compiler part is the trickiest. How to
system. See notes on Ubuntu, OS X and Windows for details. do that depends on your system. See notes on Ubuntu, OS X and Windows for
details.
```bash ```bash
# make sure you are using the latest pip # make sure you are using the latest pip
@ -243,8 +245,8 @@ Compared to regular install via pip, [requirements.txt](requirements.txt)
additionally installs developer dependencies such as Cython. For more details additionally installs developer dependencies such as Cython. For more details
and instructions, see the documentation on and instructions, see the documentation on
[compiling spaCy from source](https://spacy.io/usage#source) and the [compiling spaCy from source](https://spacy.io/usage#source) and the
[quickstart widget](https://spacy.io/usage#section-quickstart) to get [quickstart widget](https://spacy.io/usage#section-quickstart) to get the right
the right commands for your platform and Python version. commands for your platform and Python version.
### Ubuntu ### Ubuntu
@ -262,11 +264,12 @@ and git preinstalled.
### Windows ### Windows
Install a version of the [Visual C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) or Install a version of the
[Visual Studio Express](https://visualstudio.microsoft.com/vs/express/) [Visual C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
that matches the version that was used to compile your Python or [Visual Studio Express](https://visualstudio.microsoft.com/vs/express/) that
interpreter. For official distributions these are VS 2008 (Python 2.7), matches the version that was used to compile your Python interpreter. For
VS 2010 (Python 3.4) and VS 2015 (Python 3.5). official distributions these are VS 2008 (Python 2.7), VS 2010 (Python 3.4) and
VS 2015 (Python 3.5).
## Run tests ## Run tests