Introduce code from Rust monorepo. This is a mess

2026-10-18 00:33:15 +00:00 · 2022-02-28 05:43:54 -05:00
parent 921fb49f9a
commit ba326bfcfd
1058 changed files with 192192 additions and 0 deletions
@@ -0,0 +1,203 @@
+NeMo ASR collection API
+=======================
+
+
+Model Classes
+-------------
+
+.. autoclass:: nemo.collections.asr.models.EncDecCTCModel
+    :show-inheritance:
+    :members: transcribe, change_vocabulary, setup_training_data, setup_optimization, setup_validation_data, setup_test_data, register_artifact
+
+
+.. autoclass:: nemo.collections.asr.models.EncDecCTCModelBPE
+    :show-inheritance:
+    :members: transcribe, change_vocabulary, setup_training_data, setup_optimization, setup_validation_data, setup_test_data, register_artifact
+
+
+.. autoclass:: nemo.collections.asr.models.EncDecRNNTModel
+    :show-inheritance:
+    :members: transcribe, change_vocabulary, setup_training_data, setup_optimization, setup_validation_data, setup_test_data, register_artifact
+
+
+.. autoclass:: nemo.collections.asr.models.EncDecRNNTBPEModel
+    :show-inheritance:
+    :members: transcribe, change_vocabulary, setup_training_data, setup_optimization, setup_validation_data, setup_test_data, register_artifact
+
+
+.. autoclass:: nemo.collections.asr.models.EncDecClassificationModel
+    :show-inheritance:
+    :members: setup_training_data, setup_optimization, setup_validation_data, setup_test_data, register_artifact
+
+
+.. autoclass:: nemo.collections.asr.models.EncDecSpeakerLabelModel
+    :show-inheritance:
+    :members: setup_training_data, setup_optimization, setup_validation_data, setup_test_data, register_artifact
+
+
+Modules
+-------
+
+.. autoclass:: nemo.collections.asr.modules.ConvASREncoder
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.modules.ConvASRDecoder
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.modules.ConvASRDecoderClassification
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.modules.SpeakerDecoder
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.modules.ConformerEncoder
+    :show-inheritance:
+    :members:
+
+
+Parts
+-----
+
+.. autoclass:: nemo.collections.asr.parts.submodules.jasper.JasperBlock
+    :show-inheritance:
+    :members:
+
+
+Mixins
+------
+
+.. autoclass:: nemo.collections.asr.parts.mixins.mixins.ASRBPEMixin
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.mixins.mixins.ASRModuleMixin
+    :show-inheritance:
+    :members:
+
+Datasets
+--------
+
+Character Encoding Datasets
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: nemo.collections.asr.data.audio_to_text.AudioToCharDataset
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.data.audio_to_text.TarredAudioToCharDataset
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.data.audio_to_text.AudioToCharWithDursF0Dataset
+    :show-inheritance:
+    :members:
+
+Subword Encoding Datasets
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: nemo.collections.asr.data.audio_to_text.AudioToBPEDataset
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.data.audio_to_text.TarredAudioToBPEDataset
+    :show-inheritance:
+    :members:
+
+Audio Preprocessors
+-------------------
+
+.. autoclass:: nemo.collections.asr.modules.AudioToMelSpectrogramPreprocessor
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.modules.AudioToMFCCPreprocessor
+    :show-inheritance:
+    :members:
+
+Audio Augmentors
+----------------
+
+.. autoclass:: nemo.collections.asr.modules.SpectrogramAugmentation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.modules.CropOrPadSpectrogramAugmentation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.preprocessing.perturb.SpeedPerturbation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.preprocessing.perturb.TimeStretchPerturbation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.preprocessing.perturb.GainPerturbation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.preprocessing.perturb.ImpulsePerturbation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.preprocessing.perturb.ShiftPerturbation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.preprocessing.perturb.NoisePerturbation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.preprocessing.perturb.WhiteNoisePerturbation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.preprocessing.perturb.RirAndNoisePerturbation
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.preprocessing.perturb.TranscodePerturbation
+    :show-inheritance:
+    :members:
+
+Miscellaneous Classes
+---------------------
+
+RNNT Decoding
+~~~~~~~~~~~~~
+
+.. autoclass:: nemo.collections.asr.metrics.rnnt_wer.RNNTDecoding
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.metrics.rnnt_wer_bpe.RNNTBPEDecoding
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.submodules.rnnt_greedy_decoding.GreedyRNNTInfer
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.submodules.rnnt_greedy_decoding.GreedyBatchedRNNTInfer
+    :show-inheritance:
+    :members:
+
+.. autoclass:: nemo.collections.asr.parts.submodules.rnnt_beam_decoding.BeamRNNTInfer
+    :show-inheritance:
+    :members:
+
+Hypotheses
+~~~~~~~~~~
+
+.. autoclass:: nemo.collections.asr.parts.utils.rnnt_utils.Hypothesis
+    :show-inheritance:
+    :no-members:
+
+.. autoclass:: nemo.collections.asr.parts.utils.rnnt_utils.NBestHypotheses
+    :show-inheritance:
+    :no-members: