Vocab

A lookup table that allows you to access Lexeme objects. The Vocab instance also provides access to the StringStore, and owns underlying C-data that is shared between Doc objects.

Vocab.__init__

Create the vocabulary.

NameTypeDescription
lex_attr_gettersdict A dictionary mapping attribute IDs to functions to compute them. Defaults to None.
tag_mapdict A dictionary mapping fine-grained tags to coarse-grained parts-of-speech, and optionally morphological attributes.
lemmatizerobjectA lemmatizer. Defaults to None.
stringsStringStore or list A StringStore that maps strings to hash values, and vice versa, or a list of strings.
returnsVocabThe newly constructed object.

Vocab.__len__

Get the current number of lexemes in the vocabulary.

NameTypeDescription
returnsintThe number of lexems in the vocabulary.

Vocab.__getitem__

Retrieve a lexeme, given an int ID or a unicode string. If a previously unseen unicode string is given, a new lexeme is created and stored.

NameTypeDescription
id_or_stringint / unicodeThe hash value of a word, or its unicode string.
returnsLexemeThe lexeme indicated by the given ID.

Vocab.__iter__

Iterate over the lexemes in the vocabulary.

NameTypeDescription
yieldsLexemeAn entry in the vocabulary.

Vocab.__contains__

Check whether the string has an entry in the vocabulary. To get the ID for a given string, you need to look it up in vocab.strings .

NameTypeDescription
stringunicodeThe ID string.
returnsboolWhether the string has an entry in the vocabulary.

Vocab.add_flag

Set a new boolean flag to words in the vocabulary. The flag_getter function will be called over the words currently in the vocab, and then applied to new words as they occur. You'll then be able to access the flag value on each token, using token.check_flag(flag_id).

NameTypeDescription
flag_getterdictA function f(unicode) -> bool, to get the flag value.
flag_idint An integer between 1 and 63 (inclusive), specifying the bit at which the flag will be stored. If -1, the lowest available bit will be chosen.
returnsintThe integer ID by which the flag value can be checked.

Vocab.to_disk

Save the current state to a directory.

NameTypeDescription
pathunicode or Path A path to a directory, which will be created if it doesn't exist. Paths may be either strings or Path-like objects.

Vocab.from_disk

Loads state from a directory. Modifies the object in place and returns it.

NameTypeDescription
pathunicode or Path A path to a directory. Paths may be either strings or Path-like objects.
returnsVocabThe modified Vocab object.

Vocab.to_bytes

Serialize the current state to a binary string.

NameTypeDescription
**exclude-Named attributes to prevent from being serialized.
returnsbytesThe serialized form of the Vocab object.

Vocab.from_bytes

Load state from a binary string.

NameTypeDescription
bytes_databytesThe data to load from.
**exclude-Named attributes to prevent from being loaded.
returnsVocabThe Vocab object.

Attributes

NameTypeDescription
stringsStringStoreA table managing the string-to-int mapping.