From ce14520789eae6123589423613ce513ae74ead1e Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Tue, 6 Oct 2020 14:35:17 +0200 Subject: [PATCH] Update docs [ci skip] --- website/docs/usage/v3.md | 39 +++++++++++++++++---------------------- 1 file changed, 17 insertions(+), 22 deletions(-) diff --git a/website/docs/usage/v3.md b/website/docs/usage/v3.md index a10fc6321..1024a2551 100644 --- a/website/docs/usage/v3.md +++ b/website/docs/usage/v3.md @@ -168,9 +168,13 @@ follow the same unified [`Model`](https://thinc.ai/docs/api-model) API and each `Model` can also be used as a sublayer of a larger network, allowing you to freely combine implementations from different frameworks into a single model. +![Illustration of Pipe methods](../images/trainable_component.svg) + -- **Usage: ** [Layers and architectures](/usage/layers-architectures) +- **Usage: ** [Layers and architectures](/usage/layers-architectures), + [Trainable component API](/usage/processing-pipelines#trainable-components), + [Trainable components and models](/usage/layers-architectures#components) - **Thinc: ** [Wrapping PyTorch, TensorFlow & MXNet](https://thinc.ai/docs/usage-frameworks), [`Model` API](https://thinc.ai/docs/api-model) @@ -503,36 +507,27 @@ Note that spaCy v3.0 now requires **Python 3.6+**. - Pipeline package symlinks, the `link` command and shortcut names are now deprecated. There can be many [different trained pipelines](/models) and not just one "English model", so you should always use the full package name like - [`en_core_web_sm`](/models/en) explicitly. -- A pipeline's [`meta.json`](/api/data-formats#meta) is now only used to provide - meta information like the package name, author, license and labels. It's - **not** used to construct the processing pipeline anymore. This is all defined - in the [`config.cfg`](/api/data-formats#config), which also includes all - settings used to train the pipeline. -- The [`train`](/api/cli#train) and [`pretrain`](/api/cli#pretrain) commands now - only take a `config.cfg` file containing the full - [training config](/usage/training#config). + `en_core_web_sm` explicitly. +- A pipeline's `meta.json` is now only used to provide meta information like the + package name, author, license and labels. It's **not** used to construct the + processing pipeline anymore. This is all defined in the + [`config.cfg`](/api/data-formats#config), which also includes all settings + used to train the pipeline. +- The `train`, `pretrain` and `debug data` commands now only take a + `config.cfg`. - [`Language.add_pipe`](/api/language#add_pipe) now takes the **string name** of the component factory instead of the component function. - **Custom pipeline components** now need to be decorated with the [`@Language.component`](/api/language#component) or [`@Language.factory`](/api/language#factory) decorator. -- [`Language.update`](/api/language#update) now takes a batch of - [`Example`](/api/example) objects instead of raw texts and annotations, or - `Doc` and `GoldParse` objects. -- The `Language.disable_pipes` context manager has been replaced by - [`Language.select_pipes`](/api/language#select_pipes), which can explicitly - disable or enable components. - The [`Language.update`](/api/language#update), [`Language.evaluate`](/api/language#evaluate) and [`Pipe.update`](/api/pipe#update) methods now all take batches of [`Example`](/api/example) objects instead of `Doc` and `GoldParse` objects, or raw text and a dictionary of annotations. - [`Language.initialize`](/api/language#initialize) and - [`Pipe.initialize`](/api/pipe#initialize) now take a function that returns a - sequence of `Example` objects to initialize the model instead of a list of - tuples. -- The `begin_training` methods have been renamed to `initialize`. +- The `begin_training` methods have been renamed to `initialize` and now take a + function that returns a sequence of `Example` objects to initialize the model + instead of a list of tuples. - [`Matcher.add`](/api/matcher#add) and [`PhraseMatcher.add`](/api/phrasematcher#add) now only accept a list of patterns as the second argument (instead of a variable number of arguments). @@ -557,7 +552,7 @@ Note that spaCy v3.0 now requires **Python 3.6+**. | Removed | Replacement | | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Language.disable_pipes` | [`Language.select_pipes`](/api/language#select_pipes), [`Language.disable_pipe`](/api/language#disable_pipe) | +| `Language.disable_pipes` | [`Language.select_pipes`](/api/language#select_pipes), [`Language.disable_pipe`](/api/language#disable_pipe), [`Language.enable_pipe`](/api/language#enable_pipe) | | `Language.begin_training`, `Pipe.begin_training`, ... | [`Language.initialize`](/api/language#initialize), [`Pipe.initialize`](/api/pipe#initialize), ... | | `Doc.is_tagged`, `Doc.is_parsed`, ... | [`Doc.has_annotation`](/api/doc#has_annotation) | | `GoldParse` | [`Example`](/api/example) |