explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2025-06-05 13:43:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document PhraseMatcher.remove [ci skip]

Browse Source
This commit is contained in:
Ines Montani 2019-09-27 16:34:53 +02:00
parent c23edf302b
commit aad66d9bb9
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spacy/matcher/phrasematcher.pyx
View File

@ -87,6 +87,8 @@ cdef class PhraseMatcher:
the key does not exist. the key does not exist.
key (unicode): The match ID. key (unicode): The match ID.
DOCS: https://spacy.io/api/phrasematcher#remove
""" """
if key not in self._docs: if key not in self._docs:
raise KeyError(key) raise KeyError(key)

19
website/docs/api/phrasematcher.md
View File

@ -152,3 +152,22 @@ overwritten.
| `match_id` | unicode | An ID for the thing you're matching. | | `match_id` | unicode | An ID for the thing you're matching. |
| `on_match` | callable or `None` | Callback function to act on matches. Takes the arguments `matcher`, `doc`, `i` and `matches`. | | `on_match` | callable or `None` | Callback function to act on matches. Takes the arguments `matcher`, `doc`, `i` and `matches`. |
| `*docs` | list | `Doc` objects of the phrases to match. | | `*docs` | list | `Doc` objects of the phrases to match. |
## PhraseMatcher.remove {#remove tag="method" new="2.2"}
Remove a rule from the matcher by match ID. A `KeyError` is raised if the key
does not exist.
> #### Example
>
> ```python
> matcher = PhraseMatcher(nlp.vocab)
> matcher.add("OBAMA", None, nlp("Barack Obama"))
> assert "OBAMA" in matcher
> matcher.remove("OBAMA")
> assert "OBAMA" not in matcher
> ```
| Name | Type | Description |
| ----- | ------- | ------------------------- |
| `key` | unicode | The ID of the match rule. |