..
  autogenerated from source/_templates/autosummary/prototype_model_class.rst

.. currentmodule:: torchaudio.prototype.models

..

{%- set methods=["forward"] %}
{%- set helpers={
        "torchaudio.models.RNNTBeamSearch": [
            "Hypothesis",
        ],
    }
-%}
{%- set factory={
        "torchaudio.prototype.models.SquimObjective": [
            "squim_objective_model",
            "squim_objective_base",
        ],
        "torchaudio.prototype.models.ConformerWav2Vec2PretrainModel": [
            "conformer_wav2vec2_pretrain_model",
            "conformer_wav2vec2_pretrain_base",
            "conformer_wav2vec2_pretrain_large",
        ],
        "torchaudio.prototype.models.HiFiGANVocoder": [
            "hifigan_vocoder",
            "hifigan_vocoder_v1",
            "hifigan_vocoder_v2",
            "hifigan_vocoder_v3",
        ],
    }
-%}

{%- if name in ["ConvEmformer"] %}
  {{ methods.extend(["infer"]) }}
{%- endif %}

.. TITLE

{{ name | underline }}

.. CLASS DEFINITIONS

.. autoclass:: {{ fullname }}

Methods
=======

{% for item in methods %}

{{item | underline("-") }}

.. container:: py attribute

   .. automethod:: {{[fullname, item] | join('.')}}

{%- endfor %}

.. HELPER STRUCTURES

{%- if helpers[fullname] %}

Support Structures
==================

{%- for item in helpers[fullname] %}

{{item | underline("-") }}

.. container:: py attribute

   .. autodata:: {{["torchaudio.prototype.models", item] | join('.')}}
      :no-value:

{%- endfor %}

{%- endif %}

.. FACTORY FUNCTIONS

{%- if factory[fullname] %}

Factory Functions
=================

.. autosummary::
   :toctree: ../generated
   :nosignatures:

{% for item in factory[fullname] %}
   {{["~torchaudio.prototype.models", item] | join('.')}}
{%- endfor %}

{%- endif %}
