.. nkululeko documentation master file, created by
   sphinx-quickstart on Mon Jul 24 16:18:58 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

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 several variables, e.g., acoustic features and models (classifier or regressor), feature standardization, augmentation, etc.,  for speaker characteristics detection,
2. Characteristics of the database, such as distribution 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 <https://felixbur.github.io/nkululeko/>`__ and `Felix's web page <http://blog.syntheticspeech.de/category/nkululeko/>`__. 

There is also `a deepwiki available <https://deepwiki.com/felixbur/nkululeko>`__. You can directly ask your question there (Nkululeko Github also can be used with Copilot).

.. toctree::
   :maxdepth: 1
   :caption: Explanation
   
   overview.md
   architecture.md
   glossary.md

.. toctree::
   :maxdepth: 1
   :caption: How-to Guides

   installation
   usage.md
   ini_file.md

.. toctree::
   :maxdepth: 1
   :caption: Visualization

   plots.md
   visualization.md

.. toctree::
   :maxdepth: 2
   :caption: Tutorials

   how_to.md
   hello_world_aud.md
   hello_world_csv.md
   emotion_prediction.md
   comparing.md
   scaler.md
   balance.md
   regplot.md
   tut_activation_functions.md
   text_processing.md
   align_databases.md
   uncertainty.md
   compare_runs.md
   linguistics.md
   traindevtest.md
   predict_speaker.md
   finetune.md
   test_module.md
   test_new_database.md
   split_data.md
   bundle.md

   ../EER_IMPLEMENTATION.md

.. toctree::
   :maxdepth: 2
   :caption: Modules

   experiment.md
   explore.md
   augment.md
   resample.md
   segment.md
   optim.md
   predict.md
   multidb.md
   ensemble.md
   flags.md
   avqi.md


.. toctree::
   :maxdepth: 2
   :caption: API Reference

   nkululeko


.. automodule:: nkululeko
   :members:
   :undoc-members:
   :show-inheritance:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
