Welcome to nkululeko’s documentation!

This documentation contains installation, usage, INI file format, and tutorials of Nkululeko, Machine Learning Speaker Characteristics. The program is intended for novice people interested in speaker characteristics detection (e.g., emotion, age, and gender) without proficient in (Python) programming language. Main features of Nkululeko are:

1. Finding good combinations of acoustic features and models (classifier or regressor) for speaker characteristics detection,

2. Characteristics of the database, such as distibution of gender, age, emotion, duration, data size, and so on with their visualization,

3. Inference of speaker characteristics from a given audio file or streaming audio (can be said also as “weak” labeling for semi-supervised learning).

Altogether, this make Nkululeko as a good teaching/learning tool for speaker characteristics detection by machine learning.

The examples only covers some important features of Nkululeko. For more details, please refer to the Nkululeko Github page and Felix’s web page.

Installation:

• Installation

Usage

• Usage

INI File

• Overview of options for the nkululeko framework

Tutorials

• Nkululeko Workflow
• Hello world [AUDFORMAT]
• Hello World [CSV]
  • Dataset Location
• Comparing classifiers and features
• Test module
• Demo module
  • Needed Configuration For Demo Module
  • Predicting an audio file or live streaming from microphone
  • Predicting a list of audio files
• Multidb module for database comparison

API Reference

• nkululeko package
  • Subpackages
  • Submodules
  • nkululeko.aug_train module
  • nkululeko.augment module
  • nkululeko.cacheddataset module
  • nkululeko.constants module
  • nkululeko.demo module
  • nkululeko.demo_feats module
  • nkululeko.demo_predictor module
  • nkululeko.experiment module
  • nkululeko.explore module
  • nkululeko.export module
  • nkululeko.feature_extractor module
  • nkululeko.file_checker module
  • nkululeko.filter_data module
  • nkululeko.glob_conf module
  • nkululeko.modelrunner module
  • nkululeko.multidb module
  • nkululeko.nkululeko module
  • nkululeko.plots module
  • nkululeko.predict module
  • nkululeko.reporter module
  • nkululeko.resample module
  • nkululeko.result module
  • nkululeko.runmanager module
  • nkululeko.scaler module
  • nkululeko.segment module
  • nkululeko.syllable_nuclei module
  • nkululeko.test module
  • nkululeko.test_predictor module
  • Module contents
• nkululeko.augmenting package
  • Submodules
  • nkululeko.augmenting.augmenter module
  • nkululeko.augmenting.randomsplicer module
  • nkululeko.augmenting.randomsplicing module
  • nkululeko.augmenting.resampler module
  • Module contents
• nkululeko.autopredict package
  • Submodules
  • nkululeko.autopredict.ap_age module
  • nkululeko.autopredict.ap_arousal module
  • nkululeko.autopredict.ap_dominance module
  • nkululeko.autopredict.ap_gender module
  • nkululeko.autopredict.ap_mos module
  • nkululeko.autopredict.ap_pesq module
  • nkululeko.autopredict.ap_sdr module
  • nkululeko.autopredict.ap_snr module
  • nkululeko.autopredict.ap_stoi module
  • nkululeko.autopredict.ap_valence module
  • nkululeko.autopredict.estimate_snr module
  • Module contents
• nkululeko.data package
  • Submodules
  • nkululeko.data.dataset module
  • nkululeko.data.dataset_csv module
  • Module contents
• nkululeko.feat_extract package
  • Submodules
  • nkululeko.feat_extract.feats_agender module
  • nkululeko.feat_extract.feats_agender_agender module
  • nkululeko.feat_extract.feats_analyser module
  • nkululeko.feat_extract.feats_audmodel module
  • nkululeko.feat_extract.feats_audmodel_dim module
  • nkululeko.feat_extract.feats_clap module
  • nkululeko.feat_extract.feats_hubert module
  • nkululeko.feat_extract.feats_import module
  • nkululeko.feat_extract.feats_mld module
  • nkululeko.feat_extract.feats_mos module
  • nkululeko.feat_extract.feats_opensmile module
  • nkululeko.feat_extract.feats_oxbow module
  • nkululeko.feat_extract.feats_praat module
  • nkululeko.feat_extract.feats_snr module
  • nkululeko.feat_extract.feats_spectra module
  • nkululeko.feat_extract.feats_spkrec module
  • nkululeko.feat_extract.feats_squim module
  • nkululeko.feat_extract.feats_trill module
  • nkululeko.feat_extract.feats_wav2vec2 module
  • nkululeko.feat_extract.feats_wavlm module
  • nkululeko.feat_extract.featureset module
  • nkululeko.feat_extract.feinberg_praat module
  • Module contents
• nkululeko.losses package
  • Submodules
  • nkululeko.losses.loss_ccc module
  • nkululeko.losses.loss_softf1loss module
  • Module contents
• nkululeko.models package
  • Submodules
  • nkululeko.models.model module
  • nkululeko.models.model_bayes module
  • nkululeko.models.model_cnn module
  • nkululeko.models.model_gmm module
  • nkululeko.models.model_knn module
  • nkululeko.models.model_knn_reg module
  • nkululeko.models.model_lin_reg module
  • nkululeko.models.model_mlp module
  • nkululeko.models.model_mlp_regression module
  • nkululeko.models.model_svm module
  • nkululeko.models.model_svr module
  • nkululeko.models.model_tree module
  • nkululeko.models.model_tree_reg module
  • nkululeko.models.model_xgb module
  • nkululeko.models.model_xgr module
  • Module contents
• nkululeko.reporting package
  • Submodules
  • nkululeko.reporting.defines module
  • nkululeko.reporting.latex_writer module
  • nkululeko.reporting.report module
  • nkululeko.reporting.report_item module
  • nkululeko.reporting.reporter module
  • nkululeko.reporting.result module
  • Module contents
• nkululeko.segmenting package
  • Submodules
  • nkululeko.segmenting.seg_inaspeechsegmenter module
  • nkululeko.segmenting.seg_silero module
  • Module contents
• nkululeko.utils package
  • Submodules
  • nkululeko.utils.files module
  • nkululeko.utils.stats module
  • nkululeko.utils.util module
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page