Shennong’s documentation

• Shennong is a toolbox for speech features extraction which provide a wide range of extraction and post-processing algorithms.

• It provides both a Python API and a command line interface.

• It is mainly based on Kaldi using the pykaldi Python adapter.

Note

Please use the following paper to cite shennong:

@misc{bernard2021shennong,
 title={Shennong: a Python toolbox for audio speech features extraction},
 author={Mathieu Bernard and Maxime Poli and Julien Karadayi and Emmanuel Dupoux},
 year={2021},
 eprint={2112.05555},
 archivePrefix={arXiv},
 primaryClass={cs.CL}
}

Contents

• Installation
  • Installation on Linux
    • Installation from conda
    • Installation from sources
  • Installation on MacOS
  • Installation on Windows
  • Installation on Docker
  • Build the documentation
• Introduction to speech features
  • Implemented models
  • Features comparison
• Command line interface
  • Simple exemple
  • Definition of <input-config>
  • Definition of <input-utterances>
  • Definition of <output-file>
• Python API reference
  • Audio data
  • Features extraction
    • Spectrogram
    • Filterbank
    • MFCC
    • PLP
    • Bottleneck
    • One hot encoding
    • Pitch estimation using Kaldi
    • Pitch estimation using CREPE
    • Energy
    • VTLN
    • UBM
  • Features post-processing
    • CMVN
    • Delta features
    • Voice Activity Detection
  • Features extraction pipeline
  • Features manipulation
    • Features
    • Features collection
  • Utterances
  • Utilities
    • Framing and windowing
    • Time alignments
    • Abstract base classes
    • Miscellaneous

Licence and copyright

Copyright 2018 - 2022, Inria

This work is founded by the grant ADT-193 from Inria and developed within the Cognitive Machine Learning research team.

---

shennong is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

shennong is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with shennong. If not, see http://www.gnu.org/licenses/.