Commit 88927e84 authored by Caroline Chen's avatar Caroline Chen Committed by Facebook GitHub Bot
Browse files

Fix docs warnings for conformer w2v2 (#2900)

Summary:
cc mthrok

Pull Request resolved: https://github.com/pytorch/audio/pull/2900

Reviewed By: mthrok

Differential Revision: D41839924

Pulled By: carolineechen

fbshipit-source-id: ba3ada7d04a86d99e08c9044de05a1c48b05d036
parent b5e4663a
...@@ -677,14 +677,14 @@ def conformer_wav2vec2_pretrain_base( ...@@ -677,14 +677,14 @@ def conformer_wav2vec2_pretrain_base(
cross_sample_negatives: int = 0, cross_sample_negatives: int = 0,
) -> ConformerWav2Vec2PretrainModel: ) -> ConformerWav2Vec2PretrainModel:
"""Build Conformer Wav2Vec2 Model for pre-training with "small" architecture from """Build Conformer Wav2Vec2 Model for pre-training with "small" architecture from
*Conformer-Based Self-Supervised Learning for Non-Speech Audio Tasks* :cite:`conformerssl` *Conformer-Based Self-Supervised Learning for Non-Speech Audio Tasks* :cite:`9746490`
Args: Args:
extractor_input_dim (int, optional): Input dimension of the features. (Default: 64) extractor_input_dim (int, optional): Input dimension of the features. (Default: 64)
extractor_output_dim (int, optional): Output dimension after feature extraction. (Default: 256) extractor_output_dim (int, optional): Output dimension after feature extraction. (Default: 256)
encoder_projection_dropout (float, optional): encoder_projection_dropout (float, optional):
The dropout probability applied after the input feature is projected to The dropout probability applied after the input feature is projected to
``embed_dim`. (Default: 0.0) ``embed_dim``. (Default: 0.0)
mask_prob (float, optional): mask_prob (float, optional):
Probability for each token to be chosen as start of the span to be masked. (Default: 0.3) Probability for each token to be chosen as start of the span to be masked. (Default: 0.3)
mask_length (int, optional): mask_length (int, optional):
...@@ -738,14 +738,14 @@ def conformer_wav2vec2_pretrain_large( ...@@ -738,14 +738,14 @@ def conformer_wav2vec2_pretrain_large(
cross_sample_negatives: int = 0, cross_sample_negatives: int = 0,
) -> ConformerWav2Vec2PretrainModel: ) -> ConformerWav2Vec2PretrainModel:
"""Build Conformer Wav2Vec2 Model for pre-training with "large" architecture from """Build Conformer Wav2Vec2 Model for pre-training with "large" architecture from
*Conformer-Based Slef-Supervised Learning for Non-Speech Audio Tasks* :cite:`conformerssl` *Conformer-Based Slef-Supervised Learning for Non-Speech Audio Tasks* :cite:`9746490`
Args: Args:
extractor_input_dim (int, optional): Input dimension of the features. (Default: 64) extractor_input_dim (int, optional): Input dimension of the features. (Default: 64)
extractor_output_dim (int, optional): Output dimension after feature extraction. (Default: 256) extractor_output_dim (int, optional): Output dimension after feature extraction. (Default: 256)
encoder_projection_dropout (float, optional): encoder_projection_dropout (float, optional):
The dropout probability applied after the input feature is projected to The dropout probability applied after the input feature is projected to
``embed_dim`. (Default: 0.0) ``embed_dim``. (Default: 0.0)
mask_prob (float, optional): mask_prob (float, optional):
Probability for each token to be chosen as start of the span to be masked. (Default: 0.3) Probability for each token to be chosen as start of the span to be masked. (Default: 0.3)
mask_length (int, optional): mask_length (int, optional):
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment