.. ldc_bpcsad documentation master file, created by
   sphinx-quickstart on Mon Sep 12 15:52:41 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

#################################################
LDC Broad Phonetic Class Speech Activity Detector
#################################################

`ldc-bpcsad` is a speech activity detector (SAD) developed at `Linguistic Data Consortium (LDC) <https://www.ldc.upenn.edu/>`_ based on `recognition of broad phonetic classes <model.html>`_. The tool was originally developed circa 2012 for internal use and now is being made available to the public. It can be accessed through either the `ldc-bpcsad command line tool <cli.html>`_ or directly through an `API <api.html>`_.



Installation
============

To install `ldc-bpcsad` and its dependencies, please follow the detailed instructions in the `installation guide <install.html>`_.


License
=======

This software is distributed under :download:`version 3 of the GNU General Public license <../../LICENSE>`.


Citation
========

If you use `ldc-bpcsad` in your research, please use the following citation:

::

  @misc{ldc-bpcsad,
    author = {Neville Ryant},
    title = {{L}inguistic {D}ata {C}onsortium {B}road {P}honetic {C}lass {S}peech {A}ctivity {D}etector (ldc-bpcsad)},
    year = {2023},
    url = {https://github.com/Linguistic-Data-Consortium/ldc-bpcsad},
  }


User guide
==========

.. toctree::
   :maxdepth: 1

   install
   model
   cli
   api