riaz.somc/transformers
1
0
Fork 0
mirror of https://github.com/huggingface/transformers.git synced 2025-07-31 18:22:34 +06:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Fix script that check objects are documented (#9259)

Browse Source
This commit is contained in:
Sylvain Gugger 2020-12-22 11:12:58 -05:00 committed by GitHub
parent e9d77ccd5a
commit 1fc7119181
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/source/model_doc/transformerxl.rst
View File

@ -87,12 +87,14 @@ TransfoXLLMHeadModel
.. autoclass:: transformers.TransfoXLLMHeadModel .. autoclass:: transformers.TransfoXLLMHeadModel
:members: forward :members: forward
TransfoXLForSequenceClassification TransfoXLForSequenceClassification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: transformers.TransfoXLForSequenceClassification .. autoclass:: transformers.TransfoXLForSequenceClassification
:members: forward :members: forward
TFTransfoXLModel TFTransfoXLModel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -107,6 +109,13 @@ TFTransfoXLLMHeadModel
:members: call :members: call
TFTransfoXLForSequenceClassification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: transformers.TFTransfoXLForSequenceClassification
:members: call
Internal Layers Internal Layers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

6
utils/check_repo.py
View File

@ -24,7 +24,7 @@ from pathlib import Path
# python utils/check_repo.py # python utils/check_repo.py
PATH_TO_TRANSFORMERS = "src/transformers" PATH_TO_TRANSFORMERS = "src/transformers"
PATH_TO_TESTS = "tests" PATH_TO_TESTS = "tests"
PATH_TO_DOC = "docs/source/model_doc" PATH_TO_DOC = "docs/source"
# Update this list for models that are not tested with a comment explaining the reason it should not be. # Update this list for models that are not tested with a comment explaining the reason it should not be.
# Being in this list is an exception and should **not** be the rule. # Being in this list is an exception and should **not** be the rule.
@ -323,6 +323,7 @@ def find_all_documented_objects():
# One good reason for not being documented is to be deprecated. Put in this list deprecated objects. # One good reason for not being documented is to be deprecated. Put in this list deprecated objects.
DEPRECATED_OBJECTS = [ DEPRECATED_OBJECTS = [
"AutoModelWithLMHead", "AutoModelWithLMHead",
"BartPretrainedModel",
"GlueDataset", "GlueDataset",
"GlueDataTrainingArguments", "GlueDataTrainingArguments",
"LineByLineTextDataset", "LineByLineTextDataset",
@ -338,6 +339,7 @@ DEPRECATED_OBJECTS = [
"SquadV1Processor", "SquadV1Processor",
"SquadV2Processor", "SquadV2Processor",
"TFAutoModelWithLMHead", "TFAutoModelWithLMHead",
"TFBartPretrainedModel",
"TextDataset", "TextDataset",
"TextDatasetForNextSentencePrediction", "TextDatasetForNextSentencePrediction",
"glue_compute_metrics", "glue_compute_metrics",
@ -456,7 +458,7 @@ def check_repo_quality():
check_all_decorator_order() check_all_decorator_order()
check_all_models_are_tested() check_all_models_are_tested()
print("Checking all objects are properly documented.") print("Checking all objects are properly documented.")
check_all_objects_are_documented check_all_objects_are_documented()
print("Checking all models are in at least one auto class.") print("Checking all models are in at least one auto class.")
check_all_models_are_auto_configured() check_all_models_are_auto_configured()