Rooba
/
spaCy
mirror of https://github.com/explosion/spaCy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update cli.download and cli.validate docs

This commit is contained in:
ines 2018-01-03 21:34:03 +01:00
parent 2c656f90fb
commit ef210c73dd
1 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
website/api/cli.jade
View File

@ -17,6 +17,17 @@ p
| Direct downloads don't perform any compatibility checks and require the | Direct downloads don't perform any compatibility checks and require the
| model name to be specified with its version (e.g., #[code en_core_web_sm-1.2.0]). | model name to be specified with its version (e.g., #[code en_core_web_sm-1.2.0]).
+aside("Downloading best practices")
| The #[code download] command is mostly intended as a convenient,
| interactive wrapper – it performs compatibility checks and prints
| detailed messages in case things go wrong. It's #[strong not recommended]
| to use this command as part of an automated process. If you know which
| model your project needs, you should consider a
| #[+a("/usage/models#download-pip") direct download via pip], or
| uploading the model to a local PyPi installation and fetching it straight
| from there. This will also allow you to add it as a versioned package
| dependency to your project.
+code(false, "bash", "$"). +code(false, "bash", "$").
python -m spacy download [model] [--direct] python -m spacy download [model] [--direct]
@ -43,17 +54,6 @@ p
| The installed model package in your #[code site-packages] | The installed model package in your #[code site-packages]
| directory and a shortcut link as a symlink in #[code spacy/data]. | directory and a shortcut link as a symlink in #[code spacy/data].
+aside("Downloading best practices")
| The #[code download] command is mostly intended as a convenient,
| interactive wrapper – it performs compatibility checks and prints
| detailed messages in case things go wrong. It's #[strong not recommended]
| to use this command as part of an automated process. If you know which
| model your project needs, you should consider a
| #[+a("/usage/models#download-pip") direct download via pip], or
| uploading the model to a local PyPi installation and fetching it straight
| from there. This will also allow you to add it as a versioned package
| dependency to your project.
+h(3, "link") Link +h(3, "link") Link
p p
@ -144,8 +144,14 @@ p
| #[code pip install -U spacy] to ensure that all installed models are | #[code pip install -U spacy] to ensure that all installed models are
| can be used with the new version. The command is also useful to detect | can be used with the new version. The command is also useful to detect
| out-of-sync model links resulting from links created in different virtual | out-of-sync model links resulting from links created in different virtual
| environments. Prints a list of models, the installed versions, the latest | environments. It will a list of models, the installed versions, the
| compatible version (if out of date) and the commands for updating. | latest compatible version (if out of date) and the commands for updating.
+aside("Automated validation")
| You can also use the #[code validate] command as part of your build
| process or test suite, to ensure all models are up to date before
| proceeding. If incompatible models or shortcut links are found, it will
| return #[code 1].
+code(false, "bash", "$"). +code(false, "bash", "$").
python -m spacy validate python -m spacy validate