SpeechBrain
v0.5.15

Getting started:

  • Quick installation
    • Install via PyPI
    • Install locally
    • Test installation
    • Operating Systems
    • Anaconda and venv
    • Anaconda setup
    • venv setup
    • Test your GPU installation
  • Running an experiment
    • YAML basics
      • Security note
      • Features
    • Running arguments
    • Tensor format
  • Basics of multi-GPU
    • Multi-GPU training using Distributed Data Parallel (DDP)
      • Writing DDP-safe code in SpeechBrain
      • Single-node setup
      • Multi-node setup
        • Basics & manual multi-node setup
        • Multi-node setup with Slurm
    • (DEPRECATED) Single-node multi-GPU training using Data Parallel
  • Tutorials
  • Contributing
    • Zen of Speechbrain
    • How to get your code in SpeechBrain
    • Python
      • Version
      • Formatting
      • Adding dependencies
      • Testing
    • Documentation
    • Development tools
      • flake8
      • pre-commit
      • the git pre-commit hooks
      • the git pre-push hooks
      • pytest doctests
    • Continuous integration
      • What is CI?
      • CI / CD Pipelines
      • Our test suite
    • Pull Request review guide
    • Releasing a new version
  • Guiding contributors, reviewers & maintainers through the complexity of SpeechBrain testing.
    • Functionality provided on multiple platforms, in the SpeechBrain ecosystem.
    • How is functionality provided?
    • How is the SpeechBrain community improving quality, continuously?
    • The location of a change foreshadows its integrative complexity.
    • Branch topology: release <- CI/CD <- ecosystem-spanning refactorings.
  • What testing coverage approaches are needed?
    • Where to get things done?
    • GitHub workflow: strategy by configuration
      • pre-commit.yml
      • pythonapp.yml
      • verify-docs-gen.yml [I.2.a]
      • newtag.yml
      • release.yml
    • PyTest for reporting code coverage rates

API Documentation:

  • Core library (speechbrain)
    • speechbrain.core module
      • Summary
      • Reference
        • create_experiment_directory()
        • parse_arguments()
        • Stage
        • Brain
    • speechbrain.alignment
      • speechbrain.alignment.aligner module
        • Summary
        • Reference
      • speechbrain.alignment.ctc_segmentation module
        • Summary
        • Reference
    • speechbrain.dataio
      • speechbrain.dataio.batch module
        • Summary
        • Reference
      • speechbrain.dataio.dataio module
        • Summary
        • Reference
      • speechbrain.dataio.dataloader module
        • Summary
        • Reference
      • speechbrain.dataio.dataset module
        • Summary
        • Reference
      • speechbrain.dataio.encoder module
        • Summary
        • Reference
      • speechbrain.dataio.iterators module
        • Summary
        • Reference
      • speechbrain.dataio.legacy module
        • Summary
        • Reference
      • speechbrain.dataio.preprocess module
        • Summary
        • Reference
      • speechbrain.dataio.sampler module
        • Summary
        • Reference
      • speechbrain.dataio.wer module
        • Summary
        • Reference
      • Summary
      • Reference
    • speechbrain.decoders
      • speechbrain.decoders.ctc module
        • Summary
        • Reference
      • speechbrain.decoders.seq2seq module
        • Summary
        • Reference
      • speechbrain.decoders.transducer module
        • Summary
        • Reference
    • speechbrain.lm
      • speechbrain.lm.arpa module
        • Summary
        • Reference
      • speechbrain.lm.counting module
        • Summary
        • Reference
      • speechbrain.lm.ngram module
        • Summary
        • Reference
    • speechbrain.lobes
      • speechbrain.lobes.augment module
        • Summary
        • Reference
      • speechbrain.lobes.beamform_multimic module
        • Summary
        • Reference
      • speechbrain.lobes.downsampling module
        • Summary
        • Reference
      • speechbrain.lobes.features module
        • Summary
        • Reference
      • speechbrain.lobes.models
        • speechbrain.lobes.models.CRDNN module
        • speechbrain.lobes.models.Cnn14 module
        • speechbrain.lobes.models.ContextNet module
        • speechbrain.lobes.models.ECAPA_TDNN module
        • speechbrain.lobes.models.ESPnetVGG module
        • speechbrain.lobes.models.EnhanceResnet module
        • speechbrain.lobes.models.FastSpeech2 module
        • speechbrain.lobes.models.HifiGAN module
        • speechbrain.lobes.models.L2I module
        • speechbrain.lobes.models.MetricGAN module
        • speechbrain.lobes.models.MetricGAN_U module
        • speechbrain.lobes.models.PIQ module
        • speechbrain.lobes.models.RNNLM module
        • speechbrain.lobes.models.Tacotron2 module
        • speechbrain.lobes.models.VanillaNN module
        • speechbrain.lobes.models.Xvector module
        • speechbrain.lobes.models.conv_tasnet module
        • speechbrain.lobes.models.convolution module
        • speechbrain.lobes.models.dual_path module
        • speechbrain.lobes.models.fairseq_wav2vec module
        • speechbrain.lobes.models.huggingface_wav2vec module
        • speechbrain.lobes.models.huggingface_whisper module
        • speechbrain.lobes.models.resepformer module
        • speechbrain.lobes.models.segan_model module
        • speechbrain.lobes.models.wav2vec module
        • speechbrain.lobes.models.g2p
        • speechbrain.lobes.models.transformer
    • speechbrain.nnet
      • speechbrain.nnet.CNN module
        • Summary
        • Reference
      • speechbrain.nnet.RNN module
        • Summary
        • Reference
      • speechbrain.nnet.activations module
        • Summary
        • Reference
      • speechbrain.nnet.attention module
        • Summary
        • Reference
      • speechbrain.nnet.containers module
        • Summary
        • Reference
      • speechbrain.nnet.dropout module
        • Summary
        • Reference
      • speechbrain.nnet.embedding module
        • Summary
        • Reference
      • speechbrain.nnet.linear module
        • Summary
        • Reference
      • speechbrain.nnet.losses module
        • Summary
        • Reference
      • speechbrain.nnet.normalization module
        • Summary
        • Reference
      • speechbrain.nnet.pooling module
        • Summary
        • Reference
      • speechbrain.nnet.quantisers module
        • Summary
        • Reference
      • speechbrain.nnet.schedulers module
        • Summary
        • Reference
      • speechbrain.nnet.complex_networks
        • speechbrain.nnet.complex_networks.c_CNN module
        • speechbrain.nnet.complex_networks.c_RNN module
        • speechbrain.nnet.complex_networks.c_linear module
        • speechbrain.nnet.complex_networks.c_normalization module
        • speechbrain.nnet.complex_networks.c_ops module
      • speechbrain.nnet.loss
        • speechbrain.nnet.loss.guidedattn_loss module
        • speechbrain.nnet.loss.si_snr_loss module
        • speechbrain.nnet.loss.stoi_loss module
        • speechbrain.nnet.loss.transducer_loss module
      • speechbrain.nnet.quaternion_networks
        • speechbrain.nnet.quaternion_networks.q_CNN module
        • speechbrain.nnet.quaternion_networks.q_RNN module
        • speechbrain.nnet.quaternion_networks.q_linear module
        • speechbrain.nnet.quaternion_networks.q_normalization module
        • speechbrain.nnet.quaternion_networks.q_ops module
      • speechbrain.nnet.transducer
        • speechbrain.nnet.transducer.transducer_joint module
      • Summary
      • Reference
    • speechbrain.pretrained
      • speechbrain.pretrained.fetching module
        • Summary
        • Reference
      • speechbrain.pretrained.interfaces module
        • Summary
        • Reference
      • speechbrain.pretrained.training module
        • Summary
        • Reference
    • speechbrain.processing
      • speechbrain.processing.NMF module
        • Summary
        • Reference
      • speechbrain.processing.PLDA_LDA module
        • Summary
        • Reference
      • speechbrain.processing.decomposition module
        • Summary
        • Reference
      • speechbrain.processing.diarization module
      • speechbrain.processing.features module
        • Summary
        • Reference
      • speechbrain.processing.multi_mic module
        • Summary
        • Reference
      • speechbrain.processing.signal_processing module
        • Summary
        • Reference
      • speechbrain.processing.speech_augmentation module
        • Summary
        • Reference
    • speechbrain.tokenizers
      • speechbrain.tokenizers.SentencePiece module
        • Summary
        • Reference
    • speechbrain.utils
      • speechbrain.utils.Accuracy module
        • Summary
        • Reference
      • speechbrain.utils.DER module
        • Summary
        • Reference
      • speechbrain.utils.EDER module
        • Summary
        • Reference
      • speechbrain.utils.bleu module
        • Summary
        • Reference
      • speechbrain.utils.callchains module
        • Summary
        • Reference
      • speechbrain.utils.checkpoints module
        • Summary
        • Reference
      • speechbrain.utils.data_pipeline module
        • Summary
        • Reference
      • speechbrain.utils.data_utils module
        • Summary
        • Reference
      • speechbrain.utils.depgraph module
        • Summary
        • Reference
      • speechbrain.utils.distributed module
        • Summary
        • Reference
      • speechbrain.utils.edit_distance module
        • Summary
        • Reference
      • speechbrain.utils.epoch_loop module
        • Summary
        • Reference
      • speechbrain.utils.hparams module
        • Summary
        • Reference
      • speechbrain.utils.hpopt module
        • Summary
        • Reference
      • speechbrain.utils.logger module
        • Summary
        • Reference
      • speechbrain.utils.metric_stats module
        • Summary
        • Reference
      • speechbrain.utils.optimizers module
        • Summary
        • Reference
      • speechbrain.utils.parallel module
        • Summary
        • Reference
      • speechbrain.utils.parameter_transfer module
        • Summary
        • Reference
      • speechbrain.utils.profiling module
        • Summary
        • Reference
      • speechbrain.utils.superpowers module
        • Summary
        • Reference
      • speechbrain.utils.text_to_sequence module
        • Summary
        • Reference
      • speechbrain.utils.torch_audio_backend module
        • Summary
        • Reference
      • speechbrain.utils.train_logger module
        • Summary
        • Reference
      • Summary
      • Reference
    • speechbrain.wordemb
      • speechbrain.wordemb.transformer module
        • Summary
        • Reference
      • speechbrain.wordemb.util module
        • Summary
        • Reference
    • Summary
    • Reference
  • HyperPyYAML (hyperpyyaml)
    • hyperpyyaml.core module
      • Summary
      • Reference
        • load_hyperpyyaml()
        • RefTag
        • Placeholder
        • dump_hyperpyyaml()
        • resolve_references()
        • deref()
        • recursive_resolve()
        • parse_arithmetic()
        • recursive_update()
    • Summary
    • Reference
      • TestThing
        • TestThing.from_keys()
SpeechBrain
  • Search

© Copyright 2021, SpeechBrain. Revision adb34dbc.

Built with Sphinx using a theme provided by Read the Docs.