2020-07-21 08:33:46 +00:00
---
title: Morphology
tag: class
source: spacy/morphology.pyx
---
2020-07-29 09:36:42 +00:00
Store the possible morphological analyses for a language, and index them by
hash. To save space on each token, tokens only know the hash of their
2020-07-21 08:33:46 +00:00
morphological analysis, so queries of morphological attributes are delegated to
2020-08-17 14:45:24 +00:00
this class. See [`MorphAnalysis` ](/api/morphology#morphansalysis ) for the
container storing a single morphological analysis.
2020-07-21 08:33:46 +00:00
## Morphology.\_\_init\_\_ {#init tag="method"}
2020-08-07 13:27:13 +00:00
Create a Morphology object.
2020-07-21 08:33:46 +00:00
> #### Example
>
> ```python
> from spacy.morphology import Morphology
>
2020-08-07 13:27:13 +00:00
> morphology = Morphology(strings)
2020-07-21 08:33:46 +00:00
> ```
2020-08-17 14:45:24 +00:00
| Name | Description |
| --------- | --------------------------------- |
| `strings` | The string store. ~~StringStore~~ |
2020-07-21 08:33:46 +00:00
## Morphology.add {#add tag="method"}
2020-07-29 09:36:42 +00:00
Insert a morphological analysis in the morphology table, if not already present.
2020-08-17 14:45:24 +00:00
The morphological analysis may be provided in the Universal Dependencies
[FEATS ](https://universaldependencies.org/format.html#morphological-annotation )
format as a string or in the tag map dictionary format. Returns the hash of the
new analysis.
2020-07-21 08:33:46 +00:00
> #### Example
>
> ```python
> feats = "Feat1=Val1|Feat2=Val2"
> hash = nlp.vocab.morphology.add(feats)
> assert hash == nlp.vocab.strings[feats]
> ```
2020-08-17 14:45:24 +00:00
| Name | Description |
| ---------- | ------------------------------------------------ |
| `features` | The morphological features. ~~Union[Dict, str]~~ |
2020-07-21 08:33:46 +00:00
## Morphology.get {#get tag="method"}
> #### Example
>
> ```python
> feats = "Feat1=Val1|Feat2=Val2"
> hash = nlp.vocab.morphology.add(feats)
> assert nlp.vocab.morphology.get(hash) == feats
> ```
2020-08-17 14:45:24 +00:00
Get the
[FEATS ](https://universaldependencies.org/format.html#morphological-annotation )
string for the hash of the morphological analysis.
2020-07-21 08:33:46 +00:00
2020-08-17 14:45:24 +00:00
| Name | Description |
| ------- | ----------------------------------------------- |
| `morph` | The hash of the morphological analysis. ~~int~~ |
2020-07-21 08:33:46 +00:00
## Morphology.feats_to_dict {#feats_to_dict tag="staticmethod"}
2020-08-17 14:45:24 +00:00
Convert a string
[FEATS ](https://universaldependencies.org/format.html#morphological-annotation )
representation to a dictionary of features and values in the same format as the
tag map.
2020-07-21 08:33:46 +00:00
> #### Example
>
> ```python
> from spacy.morphology import Morphology
> d = Morphology.feats_to_dict("Feat1=Val1|Feat2=Val2")
> assert d == {"Feat1": "Val1", "Feat2": "Val2"}
> ```
2020-08-17 14:45:24 +00:00
| Name | Description |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `feats` | The morphological features in Universal Dependencies [FEATS ](https://universaldependencies.org/format.html#morphological-annotation ) format. ~~str~~ |
| **RETURNS** | The morphological features as a dictionary. ~~Dict[str, str]~~ |
2020-07-21 08:33:46 +00:00
## Morphology.dict_to_feats {#dict_to_feats tag="staticmethod"}
2020-08-17 14:45:24 +00:00
Convert a dictionary of features and values to a string
[FEATS ](https://universaldependencies.org/format.html#morphological-annotation )
representation.
2020-07-21 08:33:46 +00:00
> #### Example
>
> ```python
> from spacy.morphology import Morphology
> f = Morphology.dict_to_feats({"Feat1": "Val1", "Feat2": "Val2"})
> assert f == "Feat1=Val1|Feat2=Val2"
> ```
2020-08-17 14:45:24 +00:00
| Name | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `feats_dict` | The morphological features as a dictionary. ~~Dict[str, str]~~ |
| **RETURNS** | The morphological features as in Universal Dependencies [FEATS ](https://universaldependencies.org/format.html#morphological-annotation ) format. ~~str~~ |
2020-07-21 08:33:46 +00:00
## Attributes {#attributes}
2020-08-17 14:45:24 +00:00
| Name | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `FEATURE_SEP` | The [FEATS ](https://universaldependencies.org/format.html#morphological-annotation ) feature separator. Default is `|` . ~~str~~ |
| `FIELD_SEP` | The [FEATS ](https://universaldependencies.org/format.html#morphological-annotation ) field separator. Default is `=` . ~~str~~ |
| `VALUE_SEP` | The [FEATS ](https://universaldependencies.org/format.html#morphological-annotation ) value separator. Default is `,` . ~~str~~ |
## MorphAnalysis {#morphanalysis tag="class" source="spacy/tokens/morphanalysis.pyx"}
Stores a single morphological analysis.
### MorphAnalysis.\_\_init\_\_ {#morphanalysis-init tag="method"}
Initialize a MorphAnalysis object from a Universal Dependencies
[FEATS ](https://universaldependencies.org/format.html#morphological-annotation )
string or a dictionary of morphological features.
> #### Example
>
> ```python
> from spacy.tokens import MorphAnalysis
>
> feats = "Feat1=Val1|Feat2=Val2"
> m = MorphAnalysis(nlp.vocab, feats)
> ```
| Name | Description |
| ---------- | ---------------------------------------------------------- |
| `vocab` | The vocab. ~~Vocab~~ |
| `features` | The morphological features. ~~Union[Dict[str, str], str]~~ |
### MorphAnalysis.\_\_contains\_\_ {#morphanalysis-contains tag="method"}
Whether a feature/value pair is in the analysis.
> #### Example
>
> ```python
> feats = "Feat1=Val1,Val2|Feat2=Val2"
> morph = MorphAnalysis(nlp.vocab, feats)
> assert "Feat1=Val1" in morph
> ```
| Name | Description |
| ----------- | --------------------------------------------- |
| **RETURNS** | A feature/value pair in the analysis. ~~str~~ |
### MorphAnalysis.\_\_iter\_\_ {#morphanalysis-iter tag="method"}
Iterate over the feature/value pairs in the analysis.
> #### Example
>
> ```python
> feats = "Feat1=Val1,Val3|Feat2=Val2"
> morph = MorphAnalysis(nlp.vocab, feats)
> assert list(morph) == ["Feat1=Va1", "Feat1=Val3", "Feat2=Val2"]
> ```
| Name | Description |
| ---------- | --------------------------------------------- |
| **YIELDS** | A feature/value pair in the analysis. ~~str~~ |
### MorphAnalysis.\_\_len\_\_ {#morphanalysis-len tag="method"}
Returns the number of features in the analysis.
> #### Example
>
> ```python
> feats = "Feat1=Val1,Val2|Feat2=Val2"
> morph = MorphAnalysis(nlp.vocab, feats)
> assert len(morph) == 3
> ```
| Name | Description |
| ----------- | ----------------------------------------------- |
| **RETURNS** | The number of features in the analysis. ~~int~~ |
### MorphAnalysis.\_\_str\_\_ {#morphanalysis-str tag="method"}
Returns the morphological analysis in the Universal Dependencies
[FEATS ](https://universaldependencies.org/format.html#morphological-annotation )
string format.
> #### Example
>
> ```python
> feats = "Feat1=Val1,Val2|Feat2=Val2"
> morph = MorphAnalysis(nlp.vocab, feats)
> assert str(morph) == feats
> ```
| Name | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| **RETURNS** | The analysis in the Universal Dependencies [FEATS ](https://universaldependencies.org/format.html#morphological-annotation ) format. ~~str~~ |
### MorphAnalysis.get {#morphanalysis-get tag="method"}
Retrieve values for a feature by field.
> #### Example
>
> ```python
> feats = "Feat1=Val1,Val2"
> morph = MorphAnalysis(nlp.vocab, feats)
> assert morph.get("Feat1") == ["Val1", "Val2"]
> ```
| Name | Description |
| ----------- | ------------------------------------------------ |
| `field` | The field to retrieve. ~~str~~ |
| **RETURNS** | A list of the individual features. ~~List[str]~~ |
### MorphAnalysis.to_dict {#morphanalysis-to_dict tag="method"}
Produce a dict representation of the analysis, in the same format as the tag
map.
> #### Example
>
> ```python
> feats = "Feat1=Val1,Val2|Feat2=Val2"
> morph = MorphAnalysis(nlp.vocab, feats)
> assert morph.to_dict() == {"Feat1": "Val1,Val2", "Feat2": "Val2"}
> ```
| Name | Description |
| ----------- | ----------------------------------------------------------- |
| **RETURNS** | The dict representation of the analysis. ~~Dict[str, str]~~ |
### MorphAnalysis.from_id {#morphanalysis-from_id tag="classmethod"}
Create a morphological analysis from a given hash ID.
> #### Example
>
> ```python
> feats = "Feat1=Val1|Feat2=Val2"
> hash = nlp.vocab.strings[feats]
> morph = MorphAnalysis.from_id(nlp.vocab, hash)
> assert str(morph) == feats
> ```
| Name | Description |
| ------- | ---------------------------------------- |
| `vocab` | The vocab. ~~Vocab~~ |
| `key` | The hash of the features string. ~~int~~ |