From fa8ed9ca76bb263736cd0cf17e6f35685bce2235 Mon Sep 17 00:00:00 2001 From: Rohith ND <73429989+ndrohith09@users.noreply.github.com> Date: Tue, 18 Oct 2022 23:26:49 +0530 Subject: [PATCH] [Doctest] Add doctest for `FlavaConfig` and `FNetConfig` (#19724) --- .../models/flava/configuration_flava.py | 20 +++++++++---------- .../models/fnet/configuration_fnet.py | 4 ++-- utils/documentation_tests.txt | 2 ++ 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/src/transformers/models/flava/configuration_flava.py b/src/transformers/models/flava/configuration_flava.py index 6bd782a9ea..623a567d3b 100644 --- a/src/transformers/models/flava/configuration_flava.py +++ b/src/transformers/models/flava/configuration_flava.py @@ -78,12 +78,12 @@ class FlavaImageConfig(PretrainedConfig): Example: ```python - >>> from transformers import FlavaImageModel, FlavaImageConfig + >>> from transformers import FlavaImageConfig, FlavaImageModel >>> # Initializing a FlavaImageModel with style configuration >>> configuration = FlavaImageConfig() - >>> # Initializing a FlavaImageModel model from the style configuration + >>> # Initializing a FlavaImageModel model (with random weights) from the style configuration >>> model = FlavaImageModel(configuration) >>> # Accessing the model configuration @@ -207,12 +207,12 @@ class FlavaTextConfig(PretrainedConfig): Example: ```python - >>> from transformers import FlavaTextModel, FlavaTextConfig + >>> from transformers import FlavaTextConfig, FlavaTextModel >>> # Initializing a FlavaTextModel with style configuration >>> configuration = FlavaTextConfig() - >>> # Initializing a FlavaTextConfig from the style configuration + >>> # Initializing a FlavaTextModel model (with random weights) from the style configuration >>> model = FlavaTextModel(configuration) >>> # Accessing the model configuration @@ -316,12 +316,12 @@ class FlavaMultimodalConfig(PretrainedConfig): Example: ```python - >>> from transformers import FlavaMultimodalModel, FlavaMultimodalConfig + >>> from transformers import FlavaMultimodalConfig, FlavaMultimodalModel >>> # Initializing a FlavaMultimodalModel with style configuration >>> configuration = FlavaMultimodalConfig() - >>> # Initializing a FlavaMultimodalModel model from the style configuration + >>> # Initializing a FlavaMultimodalModel model (with random weights) from the style configuration >>> model = FlavaMultimodalModel(configuration) >>> # Accessing the model configuration @@ -410,12 +410,12 @@ class FlavaImageCodebookConfig(PretrainedConfig): Example: ```python - >>> from transformers import FlavaImageCodebook, FlavaImageCodebookConfig + >>> from transformers import FlavaImageCodebookConfig, FlavaImageCodebook >>> # Initializing a FlavaImageCodebook with style configuration >>> configuration = FlavaImageCodebookConfig() - >>> # Initializing a FlavaImageCodebook model from the style configuration + >>> # Initializing a FlavaImageCodebook model (with random weights) from the style configuration >>> model = FlavaImageCodebook(configuration) >>> # Accessing the model configuration >>> configuration = model.config @@ -515,12 +515,12 @@ class FlavaConfig(PretrainedConfig): Example: ```python - >>> from transformers import FlavaModel, FlavaForPreTraining, FlavaConfig + >>> from transformers import FlavaConfig, FlavaModel, FlavaForPreTraining >>> # Initializing a FlavaConfig with style configuration >>> configuration = FlavaConfig() - >>> # Initializing a FlavaModel and FlavaForPreTraining model from the style configuration + >>> # Initializing a FlavaModel and FlavaForPreTraining model (with random weights) from the style configuration >>> model = FlavaModel(configuration) >>> model_pre = FlavaForPreTraining(configuration) diff --git a/src/transformers/models/fnet/configuration_fnet.py b/src/transformers/models/fnet/configuration_fnet.py index 409a7891aa..29dc4c0f91 100644 --- a/src/transformers/models/fnet/configuration_fnet.py +++ b/src/transformers/models/fnet/configuration_fnet.py @@ -73,12 +73,12 @@ class FNetConfig(PretrainedConfig): Example: ```python - >>> from transformers import FNetModel, FNetConfig + >>> from transformers import FNetConfig, FNetModel >>> # Initializing a FNet fnet-base style configuration >>> configuration = FNetConfig() - >>> # Initializing a model from the fnet-base style configuration + >>> # Initializing a model (with random weights) from the fnet-base style configuration >>> model = FNetModel(configuration) >>> # Accessing the model configuration diff --git a/utils/documentation_tests.txt b/utils/documentation_tests.txt index d94d7706e9..e6cdb2100f 100644 --- a/utils/documentation_tests.txt +++ b/utils/documentation_tests.txt @@ -60,6 +60,8 @@ src/transformers/models/dpt/modeling_dpt.py src/transformers/models/electra/modeling_electra.py src/transformers/models/electra/modeling_tf_electra.py src/transformers/models/ernie/configuration_ernie.py +src/transformers/models/flava/configuration_flava.py +src/transformers/models/fnet/configuration_fnet.py src/transformers/models/glpn/modeling_glpn.py src/transformers/models/gpt2/configuration_gpt2.py src/transformers/models/gpt2/modeling_gpt2.py