explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2025-01-26 17:24:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update model docs [ci skip]

Browse Source
This commit is contained in:
Ines Montani 2019-03-17 11:48:18 +01:00
parent c6be9964ec
commit a611b32fbf
3 changed files with 29 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -163,35 +163,37 @@ or manually by pointing pip to a path or URL.
[models documentation]: https://spacy.io/docs/usage/models
```bash
# download best-matching version of specific model for your spaCy installation
python -m spacy download en_core_web_sm
# out-of-the-box: download best-matching default model
python -m spacy download en
# download best-matching version of specific model for your spaCy installation
python -m spacy download en_core_web_lg
# pip install .tar.gz archive from path or URL
pip install /Users/you/en_core_web_sm-2.0.0.tar.gz
pip install /Users/you/en_core_web_sm-2.1.0.tar.gz
pip install https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-2.1.0/en_core_web_sm-2.1.0.tar.gz
```
### Loading and using models
To load a model, use `spacy.load()` with the model's shortcut link:
To load a model, use `spacy.load()` with the model name, a shortcut link or a
path to the model data directory.
```python
import spacy
nlp = spacy.load('en')
doc = nlp(u'This is a sentence.')
nlp = spacy.load("en_core_web_sm")
doc = nlp(u"This is a sentence.")
```
If you've installed a model via pip, you can also `import` it directly and
then call its `load()` method:
You can also `import` a model directly via its full name and then call its
`load()` method with no arguments.
```python
import spacy
import en_core_web_sm
nlp = en_core_web_sm.load()
doc = nlp(u'This is a sentence.')
doc = nlp(u"This is a sentence.")
```
📖 **For more info and examples, check out the

4
website/docs/usage/index.md
View File

@ -348,8 +348,8 @@ spaCy does not currently add an entry to your `PATH` environment variable, as
this can lead to unexpected results, especially when using a virtual
environment. Instead, spaCy adds an auto-alias that maps `spacy` to
`python -m spacy]`. If this is not working as expected, run the command with
`python -m`, yourself – for example `python -m spacy download en`. For more info
on this, see the [`download`](/api/cli#download) command.
`python -m`, yourself – for example `python -m spacy download en_core_web_sm`.
For more info on this, see the [`download`](/api/cli#download) command.
</Accordion>

33
website/docs/usage/models.md
View File

@ -99,36 +99,33 @@ The easiest way to download a model is via spaCy's
best-matching model compatible with your spaCy installation.
```bash
# out-of-the-box: download best-matching default model
python -m spacy download en
# download best-matching version of specific model for your spaCy installation
# Download best-matching version of specific model for your spaCy installation
python -m spacy download en_core_web_sm
# download exact model version (doesn't create shortcut link)
python -m spacy download en_core_web_sm-2.0.0 --direct
# Out-of-the-box: download best-matching default model and create shortcut link
python -m spacy download en
# Download exact model version (doesn't create shortcut link)
python -m spacy download en_core_web_sm-2.1.0 --direct
```
The download command will [install the model](/usage/models#download-pip) via
pip, place the package in your `site-packages` directory and create a
[shortcut link](/usage/models#usage) that lets you load the model by a custom
name. The shortcut link will be the same as the model name used in
`spacy download`.
pip and place the package in your `site-packages` directory.
```bash
pip install spacy
python -m spacy download en
python -m spacy download en_core_web_sm
```
```python
import spacy
nlp = spacy.load("en")
nlp = spacy.load("en_core_web_sm")
doc = nlp(u"This is a sentence.")
```
<Infobox title="Important note" variant="warning">
To allow loading models via convenient shortcuts like `"en"`, spaCy will create
If you're downloading the models using a shortcut like `"en"`, spaCy will create
a symlink within the `spacy/data` directory. This means that your user needs the
**required permissions**. If you've installed spaCy to a system directory and
don't have admin privileges, the model linking may fail. The easiest solution is
@ -147,11 +144,11 @@ direct link to a model, head over to the
click on the archive link and copy it to your clipboard.
```bash
# with external URL
pip install https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-2.0.0/en_core_web_sm-2.0.0.tar.gz
# With external URL
pip install https://github.com/explosion/spacy-models/releases/download/en_core_web_sm-2.1.0/en_core_web_sm-2.1.0.tar.gz
# with local file
pip install /Users/you/en_core_web_md-1.2.0.tar.gz
# With local file
pip install /Users/you/en_core_web_sm-2.1.0.tar.gz
```
By default, this will install the model into your `site-packages` directory. You
@ -196,9 +193,9 @@ shortcut link, package name or a path to the data directory:
```python
import spacy
nlp = spacy.load("en") # load model with shortcut link "en"
nlp = spacy.load("en_core_web_sm") # load model package "en_core_web_sm"
nlp = spacy.load("/path/to/en_core_web_sm") # load package from a directory
nlp = spacy.load("en") # load model with shortcut link "en"
doc = nlp(u"This is a sentence.")
```