Skip to content

Latest commit

 

History

History
110 lines (84 loc) · 4.37 KB

index.rst

File metadata and controls

110 lines (84 loc) · 4.37 KB
Raw

User guide

SpeechBrain is an open-source and all-in-one speech toolkit based on PyTorch. This documentation provides install steps, tutorials and API documentation necessary to help users develop their projects.

.. dropdown:: License considerations (Apache 2.0)

   SpeechBrain is released under the `Apache License, version 2.0 <https://github.com/speechbrain/speechbrain/blob/develop/LICENSE>`_. The Apache license is a popular BSD-like license.
   SpeechBrain can be redistributed for free, even for commercial purposes, although you can not take off the license headers (and under some circumstances you may have to distribute a license document).
   Apache is not a viral license like the GPL, which forces you to release your modifications to the source code. Also note that this project has no connection to the Apache Foundation, other than that we use the same license terms.

   It is a community project, which means that discussions are engaged community-wide while decisions are taken by Dr. Ravanelli and Dr. Parcollet with respect to the community views.
   There is no legal institution associated as an owner of SpeechBrain. Furthermore, and due to the Apache License, anyone that would disagree with the way the project is being run can fork it and start a new toolkit.


.. dropdown:: Referencing SpeechBrain (BibTeX)

   If you use SpeechBrain in your research or business, please cite it using the following BibTeX entry:

   .. code-block:: bibtex

      @misc{speechbrainV1,
         title={Open-Source Conversational AI with {SpeechBrain} 1.0},
         author={Mirco Ravanelli and Titouan Parcollet and Adel Moumen and Sylvain de Langen and Cem Subakan and Peter Plantinga and Yingzhi Wang and Pooneh Mousavi and Luca Della Libera and Artem Ploujnikov and Francesco Paissan and Davide Borra and Salah Zaiem and Zeyu Zhao and Shucong Zhang and Georgios Karakasidis and Sung-Lin Yeh and Pierre Champion and Aku Rouhe and Rudolf Braun and Florian Mai and Juan Zuluaga-Gomez and Seyed Mahed Mousavi and Andreas Nautsch and Xuechen Liu and Sangeet Sagar and Jarod Duret and Salima Mdhaffar and Gaelle Laperriere and Mickael Rouvier and Renato De Mori and Yannick Esteve},
         year={2024},
         eprint={2407.00463},
         archivePrefix={arXiv},
         primaryClass={cs.LG},
         url={https://arxiv.org/abs/2407.00463},
      }
      @misc{speechbrain,
         title={SpeechBrain: A General-Purpose Speech Toolkit},
         author={Mirco Ravanelli and Titouan Parcollet and Peter Plantinga and Aku Rouhe and Samuele Cornell and Loren Lugosch and Cem Subakan and Nauman Dawalatabad and Abdelwahab Heba and Jianyuan Zhong and Ju-Chieh Chou and Sung-Lin Yeh and Szu-Wei Fu and Chien-Feng Liao and Elena Rastorgueva and François Grondin and William Aris and Hwidong Na and Yan Gao and Renato De Mori and Yoshua Bengio},
         year={2021},
         eprint={2106.04624},
         archivePrefix={arXiv},
         primaryClass={eess.AS}
      }

We provide complete Jupyter Notebook tutorials below for beginners and advanced users alike! You can view them in documentation, run them in Google Colab or run them locally with Jupyter Notebook.

.. toctree::
   :maxdepth: 1
   :caption: Getting started

   installation.md
   experiment.md
   guidance.md
   Contributing <https://github.com/speechbrain/speechbrain/blob/develop/docs/contributing.md>



.. toctree::
   :maxdepth: 1
   :caption: Tutorial notebooks

   tutorials/basics.rst
   tutorials/advanced.rst
   tutorials/preprocessing.rst
   tutorials/tasks.rst
   tutorials/nn.rst



.. toctree::
   :maxdepth: 1
   :caption: Tips & tricks

   audioloading.rst
   multigpu.md

API

.. toctree::
   :caption: API
   :hidden:
   :maxdepth: 3

   Core library (speechbrain) <API/speechbrain>
   HyperPyYAML (hyperpyyaml) <API/hyperpyyaml>


.. autosummary::

   speechbrain
   speechbrain.alignment
   speechbrain.augment
   speechbrain.dataio
   speechbrain.decoders
   speechbrain.inference
   speechbrain.k2_integration
   speechbrain.lm
   speechbrain.lobes
   speechbrain.nnet
   speechbrain.processing
   speechbrain.tokenizers
   speechbrain.utils
   speechbrain.wordemb

   hyperpyyaml.core