Update quickstart install steps (#10092)

* For conda:
  * Use conda environment rather than venv
  * Install `spacy-transformers` as a conda package
* For pip:
  * Add quotes if extras are included
This commit is contained in:
Adriane Boyd 2022-01-20 10:53:40 +01:00 committed by GitHub
parent 2ff53834bb
commit 7d528e607c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 11 deletions

View File

@ -113,8 +113,7 @@ const QuickstartInstall = ({ id, title }) => {
{ {
id: 'venv', id: 'venv',
title: 'virtual env', title: 'virtual env',
help: help: 'Use a virtual environment',
'Use a virtual environment and install spaCy into a user directory',
}, },
{ {
id: 'train', id: 'train',
@ -165,27 +164,51 @@ const QuickstartInstall = ({ id, title }) => {
setters={setters} setters={setters}
showDropdown={showDropdown} showDropdown={showDropdown}
> >
<QS config="venv">python -m venv .env</QS> <QS package="pip" config="venv">
<QS config="venv" os="mac"> python -m venv .env
</QS>
<QS package="pip" config="venv" os="mac">
source .env/bin/activate source .env/bin/activate
</QS> </QS>
<QS config="venv" os="linux"> <QS package="pip" config="venv" os="linux">
source .env/bin/activate source .env/bin/activate
</QS> </QS>
<QS config="venv" os="windows"> <QS package="pip" config="venv" os="windows">
.env\Scripts\activate .env\Scripts\activate
</QS> </QS>
<QS package="source" config="venv">
python -m venv .env
</QS>
<QS package="source" config="venv" os="mac">
source .env/bin/activate
</QS>
<QS package="source" config="venv" os="linux">
source .env/bin/activate
</QS>
<QS package="source" config="venv" os="windows">
.env\Scripts\activate
</QS>
<QS package="conda" config="venv">
conda create -n venv
</QS>
<QS package="conda" config="venv">
conda activate venv
</QS>
<QS package="pip">pip install -U pip setuptools wheel</QS> <QS package="pip">pip install -U pip setuptools wheel</QS>
<QS package="source">pip install -U pip setuptools wheel</QS> <QS package="source">pip install -U pip setuptools wheel</QS>
<QS package="pip"> <QS package="pip">
pip install -U {pkg} {pipExtras
{pipExtras && `[${pipExtras}]`} ? `pip install -U '${pkg}[${pipExtras}]'`
: `pip install -U ${pkg}`}
{nightly ? ' --pre' : ''} {nightly ? ' --pre' : ''}
</QS> </QS>
<QS package="conda">conda install -c conda-forge spacy</QS> <QS package="conda">conda install -c conda-forge spacy</QS>
<QS package="conda" hardware="gpu"> <QS package="conda" hardware="gpu">
conda install -c conda-forge cupy conda install -c conda-forge cupy
</QS> </QS>
<QS package="conda" config="train">
conda install -c conda-forge spacy-transformers
</QS>
<QS package="source"> <QS package="source">
git clone https://github.com/{repo} git clone https://github.com/{repo}
{nightly ? ` --branch ${DEFAULT_BRANCH}` : ''} {nightly ? ` --branch ${DEFAULT_BRANCH}` : ''}
@ -205,9 +228,6 @@ const QuickstartInstall = ({ id, title }) => {
<QS config="train" package="conda" comment prompt={false}> <QS config="train" package="conda" comment prompt={false}>
# packages only available via pip # packages only available via pip
</QS> </QS>
<QS config="train" package="conda">
pip install spacy-transformers
</QS>
<QS config="train" package="conda"> <QS config="train" package="conda">
pip install spacy-lookups-data pip install spacy-lookups-data
</QS> </QS>