explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2024-09-21 11:29:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6909 from svlandeg/fix/docs [ci skip]

Browse Source
This commit is contained in:
Ines Montani 2021-02-03 23:59:15 +11:00 committed by GitHub
commit efdeb9b53f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/docs/api/cli.md
View File

@ -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)~~ | | `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)~~ | | `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)~~ | | `--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)~~ | | `--gpu-id`, `-g` | GPU ID or `-1` for CPU. Defaults to `-1`. ~~int (option)~~ |
| `--help`, `-h` | Show help message and available arguments. ~~bool (flag)~~ | | `--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)~~ | | 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"} ## convert {#convert tag="command"}

15
website/docs/api/top-level.md
View File

@ -173,10 +173,9 @@ and _before_ loading any pipelines.
### spacy.require_cpu {#spacy.require_cpu tag="function" new="3.0.0"} ### spacy.require_cpu {#spacy.require_cpu tag="function" new="3.0.0"}
Allocate data and perform operations on CPU. Allocate data and perform operations on CPU. If data has already been allocated
If data has already been allocated on GPU, it will not on GPU, it will not be moved. Ideally, this function should be called right
be moved. Ideally, this function should be called right after importing spaCy after importing spaCy and _before_ loading any pipelines.
and _before_ loading any pipelines.
> #### Example > #### Example
> >
@ -186,9 +185,9 @@ and _before_ loading any pipelines.
> nlp = spacy.load("en_core_web_sm") > nlp = spacy.load("en_core_web_sm")
> ``` > ```
| Name | Description | | Name | Description |
| ----------- | ------------------------------------------------ | | ----------- | --------------- |
| **RETURNS** | `True` ~~bool~~ | | **RETURNS** | `True` ~~bool~~ |
## displaCy {#displacy source="spacy/displacy"} ## 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~~ | | `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~~ | | `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. ~~List[str]~~ |
### Corpus readers {#corpus-readers source="spacy/training/corpus.py" new="3"} ### Corpus readers {#corpus-readers source="spacy/training/corpus.py" new="3"}