explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2025-03-22 02:44:15 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.rst

Browse Source
This commit is contained in:
Ines Montani 2017-03-12 20:00:41 +01:00 committed by GitHub
parent 39dc0d98d2
commit fa0be1f2fe
1 changed files with 36 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.rst
View File

@ -37,32 +37,34 @@ software, released under the MIT license.
📖 Documentation 📖 Documentation
================ ================
+--------------------------------------------------------------------------------+---------------------------------------------------------+ =================== ===
| `Usage Workflows <https://spacy.io/docs/usage/>`_   | How to use spaCy and its features.              | `Usage Workflows`_ How to use spaCy and its features.
+--------------------------------------------------------------------------------+---------------------------------------------------------+ `API Reference`_ The detailed reference for spaCy's API.
| `API Reference <https://spacy.io/docs/api/>`_   | The detailed reference for spaCy's API. | `Tutorials`_ End-to-end examples, with code you can modify and run.
+--------------------------------------------------------------------------------+---------------------------------------------------------+ `Showcase & Demos`_ Demos, libraries and products from the spaCy community.
| `Tutorials <https://spacy.io/docs/usage/tutorials>`_ | End-to-end examples, with code you can modify and run. | `Contribute`_ How to contribute to the spaCy project and code base.
+--------------------------------------------------------------------------------+---------------------------------------------------------+ =================== ===
| `Showcase & Demos <https://spacy.io/docs/usage/showcase>`_ | Demos, libraries and products from the spaCy community. |
+--------------------------------------------------------------------------------+---------------------------------------------------------+ .. _Usage Workflows: https://spacy.io/docs/usage/
| `Contribute <https://github.com/explosion/spaCy/blob/master/CONTRIBUTING.md>`_ | How to contribute to the spaCy project and code base. | .. _API Reference: https://spacy.io/docs/api/
+--------------------------------------------------------------------------------+---------------------------------------------------------+ .. _Tutorials: https://spacy.io/docs/usage/tutorials
.. _Showcase & Demos: https://spacy.io/docs/usage/showcase
.. _Contribute: https://github.com/explosion/spaCy/blob/master/CONTRIBUTING.md
💬 Where to ask questions 💬 Where to ask questions
========================== ==========================
+---------------------------+------------------------------------------------------------------------------------------------------------+ ====================== ===
| **Bug reports**     | `GitHub Issue tracker <https://github.com/explosion/spaCy/issues>`_                                     | **Bug reports** `GitHub issue tracker`_
+---------------------------+------------------------------------------------------------------------------------------------------------+ **Usage questions** `StackOverflow`_, `Gitter chat`_, `Reddit user group`_
| **Usage questions**   | `StackOverflow <http://stackoverflow.com/questions/tagged/spacy>`_, `Reddit usergroup                     | **General discussion** `Gitter chat`_, `Reddit user group`_
| | <https://www.reddit.com/r/spacynlp>`_, `Gitter chat <https://gitter.im/explosion/spaCy>`_ | **Commercial support** contact@explosion.ai
+---------------------------+------------------------------------------------------------------------------------------------------------+ ====================== ===
| **General discussion** | `Reddit usergroup <https://www.reddit.com/r/spacynlp>`_, |
| | `Gitter chat <https://gitter.im/explosion/spaCy>`_  | .. _GitHub issue tracker: https://github.com/explosion/spaCy/issues
+---------------------------+------------------------------------------------------------------------------------------------------------+ .. _StackOverflow: http://stackoverflow.com/questions/tagged/spacy
| **Commercial support** | contact@explosion.ai                                                                                     | .. _Gitter chat: https://gitter.im/explosion/spaCy
+---------------------------+------------------------------------------------------------------------------------------------------------+ .. _Reddit user group: https://www.reddit.com/r/spacynlp
Features Features
======== ========
@ -85,7 +87,7 @@ Features
See `facts, figures and benchmarks <https://spacy.io/docs/api/>`_. See `facts, figures and benchmarks <https://spacy.io/docs/api/>`_.
Top Performance Top Performance
=============== ---------------
* Fastest in the world: <50ms per document. No faster system has ever been * Fastest in the world: <50ms per document. No faster system has ever been
announced. announced.
@ -94,21 +96,22 @@ Top Performance
accurate systems are an order of magnitude slower or more. accurate systems are an order of magnitude slower or more.
Supports Supports
======== --------
* CPython 2.6, 2.7, 3.3, 3.4, 3.5 (only 64 bit) ==================== ===
* macOS / OS X **Operating system** macOS / OS X, Linux, Windows (Cygwin, MinGW, Visual Studio)
* Linux **Python version** CPython 2.6, 2.7, 3.3, 3.4, 3.5. Only 64 bit.
* Windows (Cygwin, MinGW, Visual Studio) **Package managers** `pip`_ (source packages only), `conda`_ (via ``conda-forge``)
==================== ===
.. _pip: https://pypi.python.org/pypi/spacy
.. _conda: https://anaconda.org/conda-forge/spacy
Install spaCy Install spaCy
============= =============
spaCy is compatible with **64-bit CPython 2.6+/3.3+** and runs on **Unix/Linux**, Installation requires a working build environment. See notes on Ubuntu,
**macOS/OS X** and **Windows**. The latest spaCy releases are available over macOS/OS X and Windows for details.
`pip <https://pypi.python.org/pypi/spacy>`_ (source packages only) and
`conda <https://anaconda.org/conda-forge/spacy>`_. Installation requires a working
build environment. See notes on Ubuntu, macOS/OS X and Windows for details.
pip pip
--- ---