Documentation Home
VoxAtlas is a feature extraction engine for conversational speech.
.. raw:: html
The documentation follows an MNE-style layout: practical guides live
alongside conceptual documentation, tutorials highlight workflows, and the
API reference is generated directly from docstrings.
.. toctree::
:maxdepth: 1
:hidden:
getting_started/installation
documentation/index
tutorials/index
api/index
.. grid:: 1 2 2 2
:gutter: 3
.. grid-item-card:: Installation
:link: getting_started/installation
:link-type: doc
:class-card: landing-card
Set up a local environment, install optional extras, and build the docs.
.. grid-item-card:: Documentations
:link: documentation/index
:link-type: doc
:class-card: landing-card
Browse the project overview, architecture notes, and internal design
guides.
.. grid-item-card:: Tutorials
:link: tutorials/index
:link-type: doc
:class-card: landing-card
Follow task-oriented walkthroughs for acoustic, linguistic, and
conversation workflows.
.. grid-item-card:: API Reference
:link: api/index
:link-type: doc
:class-card: landing-card
Explore the curated user-facing API reference organized by workflow.
.. grid:: 1 1 2 2
:gutter: 3
.. grid-item-card:: Documentation Highlights
:class-card: landing-card
- :doc:`getting_started/minimal_example`
- :doc:`overview/architecture`
- :doc:`overview/pipeline`
- :doc:`overview/unit_hierarchy`
- :doc:`overview/feature_system`
.. grid-item-card:: Tutorial Highlights
:class-card: landing-card
- :doc:`tutorials/acoustic_features`
- :doc:`tutorials/linguistic_features`
- :doc:`tutorials/conversational_features`
- :doc:`tutorials/building_features`
- :doc:`developer/writing_extractors`