From a9125c7408ef83dac4add838ac3d8eb292f5d76f Mon Sep 17 00:00:00 2001 From: moto <855818+mthrok@users.noreply.github.com> Date: Wed, 6 Oct 2021 10:41:25 -0400 Subject: [PATCH 1/2] Update docs to list all the pretrained models --- docs/source/models.rst | 127 +++++++++++++++++++++++++++++------------ 1 file changed, 91 insertions(+), 36 deletions(-) diff --git a/docs/source/models.rst b/docs/source/models.rst index 50b285841f..4a407162c6 100644 --- a/docs/source/models.rst +++ b/docs/source/models.rst @@ -139,59 +139,114 @@ Pre-trained Models .. autoproperty:: labels - .. autodata:: WAV2VEC2_BASE - :no-value: - .. autodata:: WAV2VEC2_ASR_BASE_10M - :no-value: +WAV2VEC2_BASE +^^^^^^^^^^^^^ + +.. autodata:: WAV2VEC2_BASE + :no-value: + +WAV2VEC2_ASR_BASE_10M +^^^^^^^^^^^^^^^^^^^^^ + +.. autodata:: WAV2VEC2_ASR_BASE_10M + :no-value: + +WAV2VEC2_ASR_BASE_100H +^^^^^^^^^^^^^^^^^^^^^^ + +.. autodata:: WAV2VEC2_ASR_BASE_100H + :no-value: + +WAV2VEC2_ASR_BASE_960H +^^^^^^^^^^^^^^^^^^^^^^ + +.. autodata:: WAV2VEC2_ASR_BASE_960H + :no-value: + +WAV2VEC2_LARGE +^^^^^^^^^^^^^^ + +.. autodata:: WAV2VEC2_LARGE + :no-value: + +WAV2VEC2_ASR_LARGE_10M +^^^^^^^^^^^^^^^^^^^^^^ + +.. autodata:: WAV2VEC2_ASR_LARGE_10M + :no-value: + +WAV2VEC2_ASR_LARGE_100H +^^^^^^^^^^^^^^^^^^^^^^^ - .. autodata:: WAV2VEC2_ASR_BASE_100H - :no-value: +.. autodata:: WAV2VEC2_ASR_LARGE_100H + :no-value: - .. autodata:: WAV2VEC2_ASR_BASE_960H - :no-value: +WAV2VEC2_ASR_LARGE_960H +^^^^^^^^^^^^^^^^^^^^^^^ - .. autodata:: WAV2VEC2_LARGE - :no-value: +.. autodata:: WAV2VEC2_ASR_LARGE_960H + :no-value: - .. autodata:: WAV2VEC2_ASR_LARGE_10M - :no-value: +WAV2VEC2_LARGE_LV60K +^^^^^^^^^^^^^^^^^^^^ + +.. autodata:: WAV2VEC2_LARGE_LV60K + :no-value: - .. autodata:: WAV2VEC2_ASR_LARGE_100H - :no-value: +WAV2VEC2_ASR_LARGE_LV60K_10M +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. autodata:: WAV2VEC2_ASR_LARGE_960H - :no-value: +.. autodata:: WAV2VEC2_ASR_LARGE_LV60K_10M + :no-value: - .. autodata:: WAV2VEC2_LARGE_LV60K - :no-value: +WAV2VEC2_ASR_LARGE_LV60K_100H +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. autodata:: WAV2VEC2_ASR_LARGE_LV60K_10M - :no-value: +.. autodata:: WAV2VEC2_ASR_LARGE_LV60K_100H + :no-value: - .. autodata:: WAV2VEC2_ASR_LARGE_LV60K_100H - :no-value: +WAV2VEC2_ASR_LARGE_LV60K_960H +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. autodata:: WAV2VEC2_ASR_LARGE_LV60K_960H - :no-value: +.. autodata:: WAV2VEC2_ASR_LARGE_LV60K_960H + :no-value: - .. autodata:: WAV2VEC2_XLSR53 - :no-value: +WAV2VEC2_XLSR53 +^^^^^^^^^^^^^^^ - .. autodata:: HUBERT_BASE - :no-value: +.. autodata:: WAV2VEC2_XLSR53 + :no-value: - .. autodata:: HUBERT_LARGE - :no-value: +HUBERT_BASE +^^^^^^^^^^^ - .. autodata:: HUBERT_XLARGE - :no-value: +.. autodata:: HUBERT_BASE + :no-value: - .. autodata:: HUBERT_ASR_LARGE - :no-value: +HUBERT_LARGE +^^^^^^^^^^^^ + +.. autodata:: HUBERT_LARGE + :no-value: + +HUBERT_XLARGE +^^^^^^^^^^^^^ + +.. autodata:: HUBERT_XLARGE + :no-value: + +HUBERT_ASR_LARGE +^^^^^^^^^^^^^^^^ + +.. autodata:: HUBERT_ASR_LARGE + :no-value: + +HUBERT_ASR_XLARGE +^^^^^^^^^^^^^^^^^ - .. autodata:: HUBERT_ASR_XLARGE - :no-value: +.. autodata:: HUBERT_ASR_XLARGE + :no-value: Utility Functions ----------------- From e76f0fe258ce643dbf0444543a3740ca7c38b1e1 Mon Sep 17 00:00:00 2001 From: moto <855818+mthrok@users.noreply.github.com> Date: Wed, 6 Oct 2021 23:11:04 -0400 Subject: [PATCH 2/2] tweak class --- docs/source/models.rst | 108 +++++++++++++++++++++++++++-------------- 1 file changed, 72 insertions(+), 36 deletions(-) diff --git a/docs/source/models.rst b/docs/source/models.rst index 4a407162c6..77cf1a5cdc 100644 --- a/docs/source/models.rst +++ b/docs/source/models.rst @@ -143,110 +143,146 @@ Pre-trained Models WAV2VEC2_BASE ^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_BASE - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_BASE + :no-value: WAV2VEC2_ASR_BASE_10M ^^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_ASR_BASE_10M - :no-value: +.. container:: py attribute + + .. autodata:: torchaudio.models.WAV2VEC2_ASR_BASE_10M + :no-value: WAV2VEC2_ASR_BASE_100H ^^^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_ASR_BASE_100H - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_ASR_BASE_100H + :no-value: WAV2VEC2_ASR_BASE_960H ^^^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_ASR_BASE_960H - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_ASR_BASE_960H + :no-value: WAV2VEC2_LARGE ^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_LARGE - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_LARGE + :no-value: WAV2VEC2_ASR_LARGE_10M ^^^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_ASR_LARGE_10M - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_ASR_LARGE_10M + :no-value: WAV2VEC2_ASR_LARGE_100H ^^^^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_ASR_LARGE_100H - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_ASR_LARGE_100H + :no-value: WAV2VEC2_ASR_LARGE_960H ^^^^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_ASR_LARGE_960H - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_ASR_LARGE_960H + :no-value: WAV2VEC2_LARGE_LV60K ^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_LARGE_LV60K - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_LARGE_LV60K + :no-value: WAV2VEC2_ASR_LARGE_LV60K_10M ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_ASR_LARGE_LV60K_10M - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_ASR_LARGE_LV60K_10M + :no-value: WAV2VEC2_ASR_LARGE_LV60K_100H ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_ASR_LARGE_LV60K_100H - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_ASR_LARGE_LV60K_100H + :no-value: WAV2VEC2_ASR_LARGE_LV60K_960H ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_ASR_LARGE_LV60K_960H - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_ASR_LARGE_LV60K_960H + :no-value: WAV2VEC2_XLSR53 ^^^^^^^^^^^^^^^ -.. autodata:: WAV2VEC2_XLSR53 - :no-value: +.. container:: py attribute + + .. autodata:: WAV2VEC2_XLSR53 + :no-value: HUBERT_BASE ^^^^^^^^^^^ -.. autodata:: HUBERT_BASE - :no-value: +.. container:: py attribute + + .. autodata:: HUBERT_BASE + :no-value: HUBERT_LARGE ^^^^^^^^^^^^ -.. autodata:: HUBERT_LARGE - :no-value: +.. container:: py attribute + + .. autodata:: HUBERT_LARGE + :no-value: HUBERT_XLARGE ^^^^^^^^^^^^^ -.. autodata:: HUBERT_XLARGE - :no-value: +.. container:: py attribute + + .. autodata:: HUBERT_XLARGE + :no-value: HUBERT_ASR_LARGE ^^^^^^^^^^^^^^^^ -.. autodata:: HUBERT_ASR_LARGE - :no-value: +.. container:: py attribute + + .. autodata:: HUBERT_ASR_LARGE + :no-value: HUBERT_ASR_XLARGE ^^^^^^^^^^^^^^^^^ -.. autodata:: HUBERT_ASR_XLARGE - :no-value: +.. container:: py attribute + + .. autodata:: HUBERT_ASR_XLARGE + :no-value: Utility Functions -----------------