.. _corpus_api:

Corpora
=======

.. currentmodule::  montreal_forced_aligner.corpus.acoustic_corpus

.. autosummary::
   :toctree: generated/

   AcousticCorpus

.. currentmodule::  montreal_forced_aligner.corpus.text_corpus

.. autosummary::
   :toctree: generated/

   TextCorpus

.. currentmodule::  montreal_forced_aligner.corpus.classes

.. autosummary::
   :toctree: generated/

   FileData -- Class for representing sound file/transcription file pairs in corpora
   UtteranceData -- Class for collecting information about utterances



Helper classes and functions
============================


Multiprocessing
---------------

.. currentmodule::  montreal_forced_aligner.corpus.multiprocessing

.. autosummary::
   :toctree: generated/

   Job
   CorpusProcessWorker

Mixins
------

.. currentmodule:: montreal_forced_aligner.corpus.base

.. autosummary::
   :toctree: generated/

   CorpusMixin

.. currentmodule:: montreal_forced_aligner.corpus.acoustic_corpus

.. autosummary::
   :toctree: generated/

   AcousticCorpusMixin
   AcousticCorpusPronunciationMixin

.. currentmodule:: montreal_forced_aligner.corpus.ivector_corpus

.. autosummary::
   :toctree: generated/

   IvectorCorpusMixin

.. currentmodule:: montreal_forced_aligner.corpus.text_corpus

.. autosummary::
   :toctree: generated/

   TextCorpusMixin
   DictionaryTextCorpusMixin

Features
--------

.. currentmodule:: montreal_forced_aligner.corpus.features

.. autosummary::
   :toctree: generated/

   FeatureConfigMixin
   MfccFunction
   MfccArguments
   CalcFmllrFunction
   CalcFmllrArguments
   IvectorConfigMixin
   VadConfigMixin
   ComputeVadFunction
   VadArguments

Ivector
-------

.. currentmodule:: montreal_forced_aligner.corpus.features

.. autosummary::
   :toctree: generated/

   ExtractIvectorsFunction
   ExtractIvectorsArguments