API reference

Public package surface, feature definitions, and supporting modules.

• Package
  • Batch extraction
  • Configuration
  • Corpora helpers
• Feature definitions
  • Absolute pitch
  • Pitch class
  • Pitch interval
  • Contour
  • Timing
  • Inter-onset interval
  • Tonality
  • Metre
  • Expectation
  • Complexity
  • Lexical diversity
  • Corpus
• Feature Groups
  • get_pitch_features()
  • get_pitch_class_features()
  • temperley_likelihood()
  • get_complexity_features()
  • get_complexity_feature_bundle()
  • get_interval_features()
  • get_timing_features()
  • get_inter_onset_interval_features()
  • get_rhythm_features()
  • collect_rhythm_for_pipeline()
  • get_expectation_features()
  • get_metre_features()
  • get_fantastic_features()
  • get_jsymbolic_features()
  • get_must_features()
  • get_midi_toolbox_features()
  • get_idyom_features()
  • get_simile_features()
  • get_novel_features()
• Corpus
  • compute_corpus_ngrams()
  • save_corpus_stats()
  • load_corpus_stats()
  • load_melody()
  • load_midi_melody()
  • load_melodies_from_directory()
  • make_corpus_stats()
  • make_corpus_stats_from_json()
  • get_corpus_path()
  • get_corpus_files()
  • list_available_corpora()
• Tokenizers and n-grams
  • Melody tokenizer
  • N-gram counter
• I/O
  • import_midi()
  • load_midi()
  • list_midi_files()
  • import_midi_from_directory()
  • extract_time_signatures_from_midi()
  • extract_tempo_from_midi()
  • extract_tempo_changes_from_midi()
  • extract_key_signatures_from_midi()
• Pipeline
  • process_melody()
• Reshape
  • to_long_format()
• Feature metadata
  • FeatureRow
  • snake_to_title()
  • capitalize_ioi()
  • normalize_feature_text()
  • fix_possessive_feature_names()
  • extract_sections_from_docstring()
  • determine_type_from_return_annotation()
  • collect_feature_rows()
  • to_dataframe()
  • build_table()
  • count_features()
  • get_feature_metadata()
• Core
  • Melody
  • Helpers
• Contour
  • StepContour
  • InterpolationContour
  • PolynomialContour
  • HuronContour
  • get_huron_contour()
  • polynomial_contour_coefficients()
• IDyOM
  • is_idyom_installed()
  • install_idyom()
  • run_idyom()
  • VALID_VIEWPOINTS
• Melsim
  • install_dependencies()
  • check_r_packages_installed()
  • get_similarity_from_midi()
  • get_similarity()
  • load_midi_file()
  • BUILTIN_SIMILARITY_MEASURES