From 790ff2544af5d01b9978c8e14e56be30f565cfa8 Mon Sep 17 00:00:00 2001 From: Saad Mahmud Date: Thu, 3 Nov 2022 19:50:42 +0600 Subject: [PATCH] [Doctest] Add configuration_camembert.py (#20039) * Add example docstring for CamembertConfig * Add configuration_camembert to documentation_tests --- .../models/camembert/configuration_camembert.py | 16 +++++++++++++++- utils/documentation_tests.txt | 1 + 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/src/transformers/models/camembert/configuration_camembert.py b/src/transformers/models/camembert/configuration_camembert.py index 6f87223732..6d0e291aa6 100644 --- a/src/transformers/models/camembert/configuration_camembert.py +++ b/src/transformers/models/camembert/configuration_camembert.py @@ -41,7 +41,21 @@ class CamembertConfig(RobertaConfig): This class overrides [`RobertaConfig`]. Please check the superclass for the appropriate documentation alongside usage examples. Instantiating a configuration with the defaults will yield a similar configuration to that of the Camembert [camembert-base](https://huggingface.co/camembert-base) architecture. - """ + + Example: + + ```python + >>> from transformers import CamembertConfig, CamembertModel + + >>> # Initializing a Camembert camembert-base style configuration + >>> configuration = CamembertConfig() + + >>> # Initializing a model (with random weights) from the camembert-base style configuration + >>> model = CamembertModel(configuration) + + >>> # Accessing the model configuration + >>> configuration = model.config + ```""" model_type = "camembert" diff --git a/utils/documentation_tests.txt b/utils/documentation_tests.txt index bb02706039..b210347c31 100644 --- a/utils/documentation_tests.txt +++ b/utils/documentation_tests.txt @@ -32,6 +32,7 @@ src/transformers/models/blenderbot/modeling_blenderbot.py src/transformers/models/blenderbot_small/configuration_blenderbot_small.py src/transformers/models/blenderbot_small/modeling_blenderbot_small.py src/transformers/models/bloom/configuration_bloom.py +src/transformers/models/camembert/configuration_camembert.py src/transformers/models/canine/configuration_canine.py src/transformers/models/clip/configuration_clip.py src/transformers/models/codegen/configuration_codegen.py