API Reference

Lexicon classes

lexicon.Attribute
lexicon.Corpus
lexicon.Inventory
lexicon.FeatureMatrix
lexicon.Segment
lexicon.Transcription
lexicon.Word
lexicon.EnvironmentFilter
lexicon.Environment

Speech corpus classes

spontaneous.Discourse
spontaneous.Speaker
spontaneous.SpontaneousSpeechCorpus
spontaneous.WordToken

Corpus context managers

contextmanagers.BaseCorpusContext
contextmanagers.CanonicalVariantContext
contextmanagers.MostFrequentVariantContext
contextmanagers.SeparatedTokensVariantContext
contextmanagers.WeightedVariantContext

Corpus IO functions

Corpus binaries

binary.download_binary(name, path[, call_back]) Download a binary file of example corpora and feature matrices.
binary.load_binary(path) Unpickle a binary file
binary.save_binary(obj, path) Pickle a Corpus or FeatureMatrix object for later loading

Loading from CSV

csv.load_corpus_csv
csv.load_feature_matrix_csv

Export to CSV

csv.export_corpus_csv
csv.export_feature_matrix_csv

TextGrids

textgrid.inspect_discourse_textgrid
textgrid.load_discourse_textgrid
textgrid.load_directory_textgrid

Running text

text_spelling.inspect_discourse_spelling
text_spelling.load_discourse_spelling
text_spelling.load_directory_spelling
text_spelling.export_discourse_spelling
text_transcription.inspect_discourse_transcription
text_transcription.load_discourse_transcription
text_transcription.load_directory_transcription
text_transcription.export_discourse_transcription

Interlinear gloss text

text_ilg.inspect_discourse_ilg
text_ilg.load_discourse_ilg
text_ilg.load_directory_ilg
text_ilg.export_discourse_ilg

Other standards

multiple_files.inspect_discourse_multiple_files
multiple_files.load_discourse_multiple_files
multiple_files.load_directory_multiple_files

Analysis functions

Frequency of alternation

freq_of_alt.calc_freq_of_alt

Functional load

functional_load.minpair_fl
functional_load.deltah_fl
functional_load.relative_minpair_fl
functional_load.relative_deltah_fl

Kullback-Leibler divergence

kl.KullbackLeibler(corpus_context, seg1, …) Calculates KL distances between two Phoneme objects in some context, either the left or right-hand side.

Mutual information

mutual_information.pointwise_mi(…[, …]) Calculate the mutual information for a bigram.

Neighborhood density

neighborhood_density.neighborhood_density
neighborhood_density.find_mutation_minpairs

Phonotactic probability

phonotactic_probability.phonotactic_probability_vitevitch

Predictability of distribution

pred_of_dist.calc_prod_all_envs
pred_of_dist.calc_prod

Symbol similarity

string_similarity.string_similarity
edit_distance.edit_distance
khorsi.khorsi(word1, word2, freq_base, …) Calculate the string similarity of two words given a set of characters and their frequencies in a corpus based on Khorsi (2012)
phono_edit_distance.phono_edit_distance(…) Returns an analogue to Levenshtein edit distance but uses phonological _features instead of characters