view doc/index.rst @ 377:c6308873f239

Improve documentation, add more examples
author Amine Sehili <amine.sehili@gmail.com>
date Wed, 17 Feb 2021 21:18:05 +0100
parents 0106c4799906
children df2a320e10d5
line wrap: on
line source
auditok, an AUDIo TOKenization tool
===================================

.. image:: https://travis-ci.org/amsehili/auditok.svg?branch=master
    :target: https://travis-ci.org/amsehili/auditok
    :alt: Build Status

.. image:: https://readthedocs.org/projects/auditok/badge/?version=latest
    :target: http://auditok.readthedocs.org/en/latest/?badge=latest
    :alt: Documentation Status



``auditok`` is an **Audio Activity Detection** tool that can process online data
(read from an audio device or from standard input) as well as audio files. It
can be used as a command line program or by calling its API.


.. toctree::
    :caption: Getting started
    :maxdepth: 3

    installation
    examples

.. toctree::
    :caption: API Reference
    :maxdepth: 3

    core
    util
    io
    signal
    dataset

License
-------
MIT.