
Montreal Forced Aligner documentation
=====================================

.. grid:: 2

    .. grid-item-card:: Getting started
       :text-align: center

       :fas:`running;fa-6x i-navigation`

       ^^^

       Install the Montreal Forced Aligner and get started with examples and tutorials.

       +++

       .. button-ref:: getting_started
          :expand:
          :color: primary

          Install MFA

    .. grid-item-card:: First steps
       :text-align: center

       :fas:`terminal;fa-6x i-navigation`

       ^^^

       Have a particular use case for MFA?

       Check out the first steps tutorials.

       +++

       .. button-ref:: first_steps
          :expand:
          :color: primary

          First steps

    .. grid-item-card:: User guide
       :text-align: center

       :fas:`book-open;fa-6x i-navigation`

       ^^^

       The User Guide gives more details on input formats, available commands, and details on the various workflows available.

       +++

       .. button-ref:: user_guide
          :expand:
          :color: primary

          User guide

    .. grid-item-card:: API reference
       :text-align: center

       :fas:`file-code;fa-6x i-navigation`

       ^^^

       The API guide lists all the inner workings of MFA, the modules and classes that you can import and use in your own scripts and projects, along with details about the Kaldi functionality used.

       +++

       .. button-ref:: mfa_api
          :expand:
          :color: primary

          Reference guide

.. toctree::
   :hidden:

   Getting started <getting_started.rst>
   User guide <user_guide/index.rst>
   API reference <reference/index.rst>
   Changelog <changelog/index.rst>
