From 7d8258bec851c3b6dabfeef874f16fb1847d63dc Mon Sep 17 00:00:00 2001 From: richardpaulhudson Date: Fri, 21 Oct 2022 14:35:40 +0200 Subject: [PATCH] Correct documentation --- website/docs/api/architectures.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/website/docs/api/architectures.md b/website/docs/api/architectures.md index f34f570f8..a76c099de 100644 --- a/website/docs/api/architectures.md +++ b/website/docs/api/architectures.md @@ -210,14 +210,14 @@ one letter or letters regularly alternate with another letter or letters depending on the presence of some other letter before or after it, e.g. German plural nouns where the final two vowels are `ä-e` regularly correspond to singular lemmas where the `e` is no longer present and the `ä` has become `a`. -For most languages used with spaCy, searching is likely to be useful starting -at the end (`suff_*`), but the ability to search from the beginning (`pref_*`) -is also offered for completeness. Search characters should consist of all -characters that regularly alternate with other characters in the language in -question or whose presence before or after characters that would otherwise -alternate prevents the alternation from occurring, e.g. an `ä` in a German -plural noun does not become `a` if it is the third or fourth vowel from the -end of the word. +For most languages used with spaCy, searching is likely to be useful starting at +the end (`suff_*`), but the ability to search from the beginning (`pref_*`) is +also offered for completeness. Search characters should consist of all +characters that regularly alternate with other characters in the language in +question or whose presence before or after characters that would otherwise +alternate prevents the alternation from occurring, e.g. an `ä` in a German +plural noun does not become `a` if it is the third or fourth vowel from the end +of the word. | Name | Description | | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -227,13 +227,13 @@ end of the word. | `include_static_vectors` | Whether to also use static word vectors. Requires a vectors table to be loaded in the [`Doc`](/api/doc) objects' vocab. ~~bool~~ | | `case_sensitive` | Whether lower-case and upper-case letters should be distinguished when generating the character combinations to use as features. ~~bool~~ | | `pref_lengths` | The lengths of prefixes to use as features for each word, e.g. for the word `spaCy`: `[1, 3]` would lead to `s` and `spa` being used as features. ~~Optional[List[int]~~ | -| `suff_lengths` | The lengths of suffixes to use as features for each word, e.g. for the word `spaCy`: `[1, 3]` would lead to `y` and `aCy` being used as features. ~~Optional[List[int]~~ | | `pref_rows` | The number of rows for each of `pref_lengths`. ~~Optional[List[int]~~ | -| `pref_search_chars` | A string containing characters to search for starting from the beginning of each word. ~~Optional[str]~~ | +| `suff_lengths` | The lengths of suffixes to use as features for each word, e.g. for the word `spaCy`: `[1, 3]` would lead to `y` and `aCy` being used as features. ~~Optional[List[int]~~ | +| `suff_rows` | The number of rows for each of `suff_lengths`. ~~Optional[List[int]~~ | +| `pref_search_chars` | A string containing characters to search for starting from the beginning of each word. ~~Optional[str]~~ | | `pref_search_lengths` | The lengths of search result strings to use as features, where the searches start from the beginning of each word. ~~Optional[List[int]]~~ | | `pref_search_rows` | The number of rows for each of `pref_search_lengths`. ~~Optional[List[int]~~ | -| `suff_rows` | The number of rows for each of `suff_lengths`. ~~Optional[List[int]~~ | -| `suff_search_chars` | A string containing characters to search for starting from the end of each word. ~~Optional[str]~~ | +| `suff_search_chars` | A string containing characters to search for starting from the end of each word. ~~Optional[str]~~ | | `suff_search_lengths` | The lengths of search result strings to use as features, where the searches start from the end of each word. ~~Optional[List[int]]~~ | | `suff_search_rows` | The number of rows for each of `suff_search_lengths`. ~~Optional[List[int]~~ | | **CREATES** | The model using the architecture. ~~Model[List[Doc], List[Floats2d]]~~ |