From 45c551037d467ae7d0c359d53e05838cc4c6a81f Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Sat, 30 Jan 2021 21:50:23 +1100 Subject: [PATCH] Update CLI docs [ci skip] --- website/docs/api/cli.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/website/docs/api/cli.md b/website/docs/api/cli.md index 44ffea467..e53fda733 100644 --- a/website/docs/api/cli.md +++ b/website/docs/api/cli.md @@ -28,7 +28,9 @@ available arguments and usage. Download [trained pipelines](/usage/models) for spaCy. The downloader finds the best-matching compatible version and uses `pip install` to download the Python package. Direct downloads don't perform any compatibility checks and require the -pipeline name to be specified with its version (e.g. `en_core_web_sm-2.2.0`). +pipeline name to be specified with its version (e.g. `en_core_web_sm-3.0.0`). +Setting the `--wheel` flag will download a binary wheel file instead of an +archive, which can be faster and more memory efficient. > #### Downloading best practices > @@ -42,16 +44,17 @@ pipeline name to be specified with its version (e.g. `en_core_web_sm-2.2.0`). > project. ```cli -$ python -m spacy download [model] [--direct] [pip_args] +$ python -m spacy download [model] [--wheel] [--direct] [pip_args] ``` -| Name | Description | -| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | Pipeline package name, e.g. [`en_core_web_sm`](/models/en#en_core_web_sm). ~~str (positional)~~ | -| `--direct`, `-d` | Force direct download of exact package version. ~~bool (flag)~~ | -| `--help`, `-h` | Show help message and available arguments. ~~bool (flag)~~ | -| pip args 2.1 | Additional installation options to be passed to `pip install` when installing the pipeline package. For example, `--user` to install to the user home directory or `--no-deps` to not install package dependencies. ~~Any (option/flag)~~ | -| **CREATES** | The installed pipeline package in your `site-packages` directory. | +| Name | Description | +| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `model` | Pipeline package name, e.g. [`en_core_web_sm`](/models/en#en_core_web_sm). ~~str (positional)~~ | +| `--wheel`, `-W` 3 | Download binary wheel package instead of `.tar.gz` archive. Can make download and installation faster and more memory efficient. ~~bool (flag)~~ | +| `--direct`, `-D` | Force direct download of exact package version. ~~bool (flag)~~ | +| `--help`, `-h` | Show help message and available arguments. ~~bool (flag)~~ | +| pip args 2.1 | Additional installation options to be passed to `pip install` when installing the pipeline package. For example, `--user` to install to the user home directory or `--no-deps` to not install package dependencies. ~~Any (option/flag)~~ | +| **CREATES** | The installed pipeline package in your `site-packages` directory. | ## info {#info tag="command"}