diff --git a/README.md b/README.md index 6bdbc7e46..7253d564b 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ # spaCy: Industrial-strength NLP 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 +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 state-of-the-art speed, convolutional **neural network models** for tagging, 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 -The spaCy project is maintained by [@honnibal](https://github.com/honnibal) -and [@ines](https://github.com/ines), along with core contributors +The spaCy project is maintained by [@honnibal](https://github.com/honnibal) and +[@ines](https://github.com/ines), along with core contributors [@svlandeg](https://github.com/svlandeg) and [@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 -much more valuable if it's shared publicly, so that more people can benefit -from it. +much more valuable if it's shared publicly, so that more people can benefit from +it. | Type | Platforms | | ------------------------ | ------------------------------------------------------ | @@ -94,7 +94,8 @@ from it. For detailed installation instructions, see the [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) - **Package managers**: [pip] 路 [conda] (via `conda-forge`) @@ -103,8 +104,8 @@ For detailed installation instructions, see the ### pip -Using pip, spaCy releases are available as source packages and binary wheels -(as of `v2.0.13`). +Using pip, spaCy releases are available as source packages and binary wheels (as +of `v2.0.13`). ```bash pip install spacy @@ -129,9 +130,9 @@ 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. +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. ### Updating spaCy @@ -154,10 +155,10 @@ with the new version. ## Download models -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 -other module. Models can be installed using spaCy's `download` command, -or manually by pointing pip to a path or URL. +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 other module. +Models can be installed using spaCy's `download` command, or manually by +pointing pip to a path or URL. | Documentation | | | ---------------------- | ------------------------------------------------------------- | @@ -206,8 +207,8 @@ doc = nlp(u"This is a sentence.") ### Support for older versions -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` +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` 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 @@ -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 Python distribution including header files, a compiler, [pip](https://pip.pypa.io/en/latest/installing/), -[virtualenv](https://virtualenv.pypa.io/en/latest/) 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. +[virtualenv](https://virtualenv.pypa.io/en/latest/) 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. ```bash # 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 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. +[quickstart widget](https://spacy.io/usage#section-quickstart) to get the right +commands for your platform and Python version. ### Ubuntu @@ -262,11 +264,12 @@ 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. For official distributions these are VS 2008 (Python 2.7), -VS 2010 (Python 3.4) and VS 2015 (Python 3.5). +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. For +official distributions these are VS 2008 (Python 2.7), VS 2010 (Python 3.4) and +VS 2015 (Python 3.5). ## Run tests