AttributeRuler
The attribute ruler lets you set token attributes for tokens identified by
Matcher patterns. The attribute ruler is
typically used to handle exceptions for token attributes and to map values
between attributes such as mapping fine-grained POS tags to coarse-grained POS
tags. See the usage guide for
examples.
Config and implementation
The default config is defined by the pipeline component factory and describes
how the component should be configured. You can override its settings via the
config argument on nlp.add_pipe or in your
config.cfg for training.
| Setting | Description |
|---|---|
validate | Whether patterns should be validated (passed to the Matcher). Defaults to False. bool |
explosion/spaCy/master/spacy/pipeline/attributeruler.py
AttributeRuler.__init__ method
Initialize the attribute ruler.
| Name | Description |
|---|---|
vocab | The shared vocabulary to pass to the matcher. Vocab |
name | Instance name of the current pipeline component. Typically passed in automatically from the factory when the component is added. str |
| keyword-only | |
validate | Whether patterns should be validated (passed to the Matcher). Defaults to False. bool |
scorer | The scoring method. Defaults to Scorer.score_token_attr for the attributes "tag“, "pos", "morph" and "lemma" and Scorer.score_token_attr_per_feat for the attribute "morph". Optional[Callable] |
AttributeRuler.__call__ method
Apply the attribute ruler to a Doc, setting token attributes for tokens
matched by the provided patterns.
| Name | Description |
|---|---|
doc | The document to process. Doc |
| RETURNS | The processed document. Doc |
AttributeRuler.add method
Add patterns to the attribute ruler. The patterns are a list of Matcher
patterns and the attributes are a dict of attributes to set on the matched
token. If the pattern matches a span of more than one token, the index can be
used to set the attributes for the token at that index in the span. The index
may be negative to index from the end of the span.
| Name | Description |
|---|---|
patterns | The Matcher patterns to add. Iterable[List[Dict[Union[int, str], Any]]] |
attrs | The attributes to assign to the target token in the matched span. Dict[str, Any] |
index | The index of the token in the matched span to modify. May be negative to index from the end of the span. Defaults to 0. int |
AttributeRuler.add_patterns method
Add patterns from a list of pattern dicts. Each pattern dict can specify the
keys "patterns", "attrs" and "index", which match the arguments of
AttributeRuler.add.
| Name | Description |
|---|---|
patterns | The patterns to add. Iterable[Dict[str, Union[List[dict], dict, int]]] |
AttributeRuler.patterns property
Get all patterns that have been added to the attribute ruler in the
patterns_dict format accepted by
AttributeRuler.add_patterns.
| Name | Description |
|---|---|
| RETURNS | The patterns added to the attribute ruler. List[Dict[str, Union[List[dict], dict, int]]] |
AttributeRuler.initialize method
Initialize the component with data and used before training to load in rules
from a file. This method is typically called by
Language.initialize and lets you customize
arguments it receives via the
[initialize.components] block in the
config.
| Name | Description |
|---|---|
get_examples | Function that returns gold-standard annotations in the form of Example objects (the training data). Not used by this component. Callable[[], Iterable[Example]] |
| keyword-only | |
nlp | The current nlp object. Defaults to None. Optional[Language] |
patterns | A list of pattern dicts with the keys as the arguments to AttributeRuler.add (patterns/attrs/index) to add as patterns. Defaults to None. Optional[Iterable[Dict[str, Union[List[dict], dict, int]]]] |
tag_map | The tag map that maps fine-grained tags to coarse-grained tags and morphological features. Defaults to None. Optional[Dict[str, Dict[Union[int, str], Union[int, str]]]] |
morph_rules | The morph rules that map token text and fine-grained tags to coarse-grained tags, lemmas and morphological features. Defaults to None. Optional[Dict[str, Dict[str, Dict[Union[int, str], Union[int, str]]]]] |
AttributeRuler.load_from_tag_map method
Load attribute ruler patterns from a tag map.
| Name | Description |
|---|---|
tag_map | The tag map that maps fine-grained tags to coarse-grained tags and morphological features. Dict[str, Dict[Union[int, str], Union[int, str]]] |
AttributeRuler.load_from_morph_rules method
Load attribute ruler patterns from morph rules.
| Name | Description |
|---|---|
morph_rules | The morph rules that map token text and fine-grained tags to coarse-grained tags, lemmas and morphological features. Dict[str, Dict[str, Dict[Union[int, str], Union[int, str]]]] |
AttributeRuler.to_disk method
Serialize the pipe to disk.
| Name | Description |
|---|---|
path | A path to a directory, which will be created if it doesn’t exist. Paths may be either strings or Path-like objects. Union[str,Path] |
| keyword-only | |
exclude | String names of serialization fields to exclude. Iterable[str] |
AttributeRuler.from_disk method
Load the pipe from disk. Modifies the object in place and returns it.
| Name | Description |
|---|---|
path | A path to a directory. Paths may be either strings or Path-like objects. Union[str,Path] |
| keyword-only | |
exclude | String names of serialization fields to exclude. Iterable[str] |
| RETURNS | The modified AttributeRuler object. AttributeRuler |
AttributeRuler.to_bytes method
Serialize the pipe to a bytestring.
| Name | Description |
|---|---|
| keyword-only | |
exclude | String names of serialization fields to exclude. Iterable[str] |
| RETURNS | The serialized form of the AttributeRuler object. bytes |
AttributeRuler.from_bytes method
Load the pipe from a bytestring. Modifies the object in place and returns it.
| Name | Description |
|---|---|
bytes_data | The data to load from. bytes |
| keyword-only | |
exclude | String names of serialization fields to exclude. Iterable[str] |
| RETURNS | The AttributeRuler object. AttributeRuler |
Serialization fields
During serialization, spaCy will export several data fields used to restore
different aspects of the object. If needed, you can exclude them from
serialization by passing in the string names via the exclude argument.
| Name | Description |
|---|---|
vocab | The shared Vocab. |
patterns | The Matcher patterns. You usually don’t want to exclude this. |
attrs | The attributes to set. You usually don’t want to exclude this. |
indices | The token indices. You usually don’t want to exclude this. |