From 94929c2b98cd7b3d7a0d069340ac50cb5c0782d2 Mon Sep 17 00:00:00 2001 From: svlandeg Date: Wed, 3 Feb 2021 13:10:22 +0100 Subject: [PATCH] small doc fixes --- website/docs/api/cli.md | 4 ++-- website/docs/api/top-level.md | 15 +++++++-------- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/website/docs/api/cli.md b/website/docs/api/cli.md index ee70f85b5..e8be0f79c 100644 --- a/website/docs/api/cli.md +++ b/website/docs/api/cli.md @@ -237,11 +237,11 @@ $ python -m spacy init labels [config_path] [output_path] [--code] [--verbose] [ | `config_path` | Path to [training config](/api/data-formats#config) file containing all settings and hyperparameters. If `-`, the data will be [read from stdin](/usage/training#config-stdin). ~~Union[Path, str] \(positional)~~ | | `output_path` | Output directory for the label files. Will create one JSON file per component. ~~Path (positional)~~ | | `--code`, `-c` | Path to Python file with additional code to be imported. Allows [registering custom functions](/usage/training#custom-functions) for new architectures. ~~Optional[Path] \(option)~~ | -| `--verbose`, `-V` | Show more detailed messages during training. ~~bool (flag)~~ | +| `--verbose`, `-V` | Show more detailed messages for debugging purposes. ~~bool (flag)~~ | | `--gpu-id`, `-g` | GPU ID or `-1` for CPU. Defaults to `-1`. ~~int (option)~~ | | `--help`, `-h` | Show help message and available arguments. ~~bool (flag)~~ | | overrides | Config parameters to override. Should be options starting with `--` that correspond to the config section and value to override, e.g. `--paths.train ./train.spacy`. ~~Any (option/flag)~~ | -| **CREATES** | The best trained pipeline and the final checkpoint (if training is terminated). | +| **CREATES** | The label files. | ## convert {#convert tag="command"} diff --git a/website/docs/api/top-level.md b/website/docs/api/top-level.md index 09a64f9e3..e025aebe5 100644 --- a/website/docs/api/top-level.md +++ b/website/docs/api/top-level.md @@ -173,10 +173,9 @@ and _before_ loading any pipelines. ### spacy.require_cpu {#spacy.require_cpu tag="function" new="3.0.0"} -Allocate data and perform operations on CPU. -If data has already been allocated on GPU, it will not -be moved. Ideally, this function should be called right after importing spaCy -and _before_ loading any pipelines. +Allocate data and perform operations on CPU. If data has already been allocated +on GPU, it will not be moved. Ideally, this function should be called right +after importing spaCy and _before_ loading any pipelines. > #### Example > @@ -186,9 +185,9 @@ and _before_ loading any pipelines. > nlp = spacy.load("en_core_web_sm") > ``` -| Name | Description | -| ----------- | ------------------------------------------------ | -| **RETURNS** | `True` ~~bool~~ | +| Name | Description | +| ----------- | --------------- | +| **RETURNS** | `True` ~~bool~~ | ## displaCy {#displacy source="spacy/displacy"} @@ -545,7 +544,7 @@ label sets. | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `path` | The path to the labels file generated with [`init labels`](/api/cli#init-labels). ~~Path~~ | | `require` | Whether to require the file to exist. If set to `False` and the labels file doesn't exist, the loader will return `None` and the `initialize` method will extract the labels from the data. Defaults to `False`. ~~bool~~ | -| **CREATES** | The | +| **CREATES** | The list of labels | ### Corpus readers {#corpus-readers source="spacy/training/corpus.py" new="3"}