From 0842c33edd5df349daddcbedb914d63e342d3c3d Mon Sep 17 00:00:00 2001 From: Suraj Patil Date: Mon, 1 Feb 2021 18:47:45 +0530 Subject: [PATCH] fix typos (#9924) --- src/transformers/models/auto/modeling_auto.py | 41 ++++++++----------- .../models/auto/modeling_tf_auto.py | 36 ++++++++-------- 2 files changed, 34 insertions(+), 43 deletions(-) diff --git a/src/transformers/models/auto/modeling_auto.py b/src/transformers/models/auto/modeling_auto.py index 993beb1991..083cecffbd 100644 --- a/src/transformers/models/auto/modeling_auto.py +++ b/src/transformers/models/auto/modeling_auto.py @@ -678,7 +678,7 @@ class AutoModel: r""" This is a generic model class that will be instantiated as one of the base model classes of the library when created with the :meth:`~transformers.AutoModel.from_pretrained` class method or the - :meth:`~transformers.AutoModel.from_config` class methods. + :meth:`~transformers.AutoModel.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). """ @@ -768,7 +768,7 @@ class AutoModel: class AutoModelForPreTraining: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with the - architecture used for pretraining this model---when created with the when created with the + architecture used for pretraining this model---when created with the :meth:`~transformers.AutoModelForPreTraining.from_pretrained` class method or the :meth:`~transformers.AutoModelForPreTraining.from_config` class method. @@ -862,9 +862,8 @@ class AutoModelForPreTraining: class AutoModelWithLMHead: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - language modeling head---when created with the when created with the - :meth:`~transformers.AutoModelWithLMHead.from_pretrained` class method or the - :meth:`~transformers.AutoModelWithLMHead.from_config` class method. + language modeling head---when created with the :meth:`~transformers.AutoModelWithLMHead.from_pretrained` class + method or the :meth:`~transformers.AutoModelWithLMHead.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). @@ -974,9 +973,8 @@ class AutoModelWithLMHead: class AutoModelForCausalLM: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a causal - language modeling head---when created with the when created with the - :meth:`~transformers.AutoModelForCausalLM.from_pretrained` class method or the - :meth:`~transformers.AutoModelForCausalLM.from_config` class method. + language modeling head---when created with the :meth:`~transformers.AutoModelForCausalLM.from_pretrained` class + method or the :meth:`~transformers.AutoModelForCausalLM.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). """ @@ -1068,9 +1066,8 @@ class AutoModelForCausalLM: class AutoModelForMaskedLM: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a masked - language modeling head---when created with the when created with the - :meth:`~transformers.AutoModelForMaskedLM.from_pretrained` class method or the - :meth:`~transformers.AutoModelForMaskedLM.from_config` class method. + language modeling head---when created with the :meth:`~transformers.AutoModelForMaskedLM.from_pretrained` class + method or the :meth:`~transformers.AutoModelForMaskedLM.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). """ @@ -1162,7 +1159,7 @@ class AutoModelForMaskedLM: class AutoModelForSeq2SeqLM: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - sequence-to-sequence language modeling head---when created with the when created with the + sequence-to-sequence language modeling head---when created with the :meth:`~transformers.AutoModelForSeq2SeqLM.from_pretrained` class method or the :meth:`~transformers.AutoModelForSeq2SeqLM.from_config` class method. @@ -1260,7 +1257,7 @@ class AutoModelForSeq2SeqLM: class AutoModelForSequenceClassification: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - sequence classification head---when created with the when created with the + sequence classification head---when created with the :meth:`~transformers.AutoModelForSequenceClassification.from_pretrained` class method or the :meth:`~transformers.AutoModelForSequenceClassification.from_config` class method. @@ -1358,9 +1355,8 @@ class AutoModelForSequenceClassification: class AutoModelForQuestionAnswering: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - question answering head---when created with the when created with the - :meth:`~transformers.AutoModeForQuestionAnswering.from_pretrained` class method or the - :meth:`~transformers.AutoModelForQuestionAnswering.from_config` class method. + question answering head---when created with the :meth:`~transformers.AutoModeForQuestionAnswering.from_pretrained` + class method or the :meth:`~transformers.AutoModelForQuestionAnswering.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). """ @@ -1457,7 +1453,7 @@ class AutoModelForQuestionAnswering: class AutoModelForTableQuestionAnswering: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a table - question answering head---when created with the when created with the + question answering head---when created with the :meth:`~transformers.AutoModeForTableQuestionAnswering.from_pretrained` class method or the :meth:`~transformers.AutoModelForTableQuestionAnswering.from_config` class method. @@ -1557,9 +1553,8 @@ class AutoModelForTableQuestionAnswering: class AutoModelForTokenClassification: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a token - classification head---when created with the when created with the - :meth:`~transformers.AutoModelForTokenClassification.from_pretrained` class method or the - :meth:`~transformers.AutoModelForTokenClassification.from_config` class method. + classification head---when created with the :meth:`~transformers.AutoModelForTokenClassification.from_pretrained` + class method or the :meth:`~transformers.AutoModelForTokenClassification.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). """ @@ -1656,7 +1651,7 @@ class AutoModelForTokenClassification: class AutoModelForMultipleChoice: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - multiple choice classification head---when created with the when created with the + multiple choice classification head---when created with the :meth:`~transformers.AutoModelForMultipleChoice.from_pretrained` class method or the :meth:`~transformers.AutoModelForMultipleChoice.from_config` class method. @@ -1755,8 +1750,8 @@ class AutoModelForMultipleChoice: class AutoModelForNextSentencePrediction: r""" - This is a generic model class that will be instantiated as one of the model classes of the library---with a - multiple choice classification head---when created with the when created with the + This is a generic model class that will be instantiated as one of the model classes of the library---with a next + sentence prediction head---when created with the :meth:`~transformers.AutoModelForNextSentencePrediction.from_pretrained` class method or the :meth:`~transformers.AutoModelForNextSentencePrediction.from_config` class method. diff --git a/src/transformers/models/auto/modeling_tf_auto.py b/src/transformers/models/auto/modeling_tf_auto.py index b127ecda0d..43ce55dbab 100644 --- a/src/transformers/models/auto/modeling_tf_auto.py +++ b/src/transformers/models/auto/modeling_tf_auto.py @@ -539,7 +539,7 @@ class TFAutoModel(object): r""" This is a generic model class that will be instantiated as one of the base model classes of the library when created with the when created with the :meth:`~transformers.TFAutoModel.from_pretrained` class method or the - :meth:`~transformers.TFAutoModel.from_config` class methods. + :meth:`~transformers.TFAutoModel.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). """ @@ -629,7 +629,7 @@ class TFAutoModel(object): class TFAutoModelForPreTraining(object): r""" This is a generic model class that will be instantiated as one of the model classes of the library---with the - architecture used for pretraining this model---when created with the when created with the + architecture used for pretraining this model---when created with the :meth:`~transformers.TFAutoModelForPreTraining.from_pretrained` class method or the :meth:`~transformers.TFAutoModelForPreTraining.from_config` class method. @@ -723,9 +723,8 @@ class TFAutoModelForPreTraining(object): class TFAutoModelWithLMHead(object): r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - language modeling head---when created with the when created with the - :meth:`~transformers.TFAutoModelWithLMHead.from_pretrained` class method or the - :meth:`~transformers.TFAutoModelWithLMHead.from_config` class method. + language modeling head---when created with the :meth:`~transformers.TFAutoModelWithLMHead.from_pretrained` class + method or the :meth:`~transformers.TFAutoModelWithLMHead.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). @@ -836,9 +835,8 @@ class TFAutoModelWithLMHead(object): class TFAutoModelForCausalLM: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a causal - language modeling head---when created with the when created with the - :meth:`~transformers.TFAutoModelForCausalLM.from_pretrained` class method or the - :meth:`~transformers.TFAutoModelForCausalLM.from_config` class method. + language modeling head---when created with the :meth:`~transformers.TFAutoModelForCausalLM.from_pretrained` class + method or the :meth:`~transformers.TFAutoModelForCausalLM.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). """ @@ -930,9 +928,8 @@ class TFAutoModelForCausalLM: class TFAutoModelForMaskedLM: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a masked - language modeling head---when created with the when created with the - :meth:`~transformers.TFAutoModelForMaskedLM.from_pretrained` class method or the - :meth:`~transformers.TFAutoModelForMaskedLM.from_config` class method. + language modeling head---when created with the :meth:`~transformers.TFAutoModelForMaskedLM.from_pretrained` class + method or the :meth:`~transformers.TFAutoModelForMaskedLM.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). """ @@ -1024,7 +1021,7 @@ class TFAutoModelForMaskedLM: class TFAutoModelForSeq2SeqLM: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - sequence-to-sequence language modeling head---when created with the when created with the + sequence-to-sequence language modeling head---when created with the :meth:`~transformers.TFAutoModelForSeq2SeqLM.from_pretrained` class method or the :meth:`~transformers.TFAutoModelForSeq2SeqLM.from_config` class method. @@ -1122,7 +1119,7 @@ class TFAutoModelForSeq2SeqLM: class TFAutoModelForSequenceClassification(object): r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - sequence classification head---when created with the when created with the + sequence classification head---when created with the :meth:`~transformers.TFAutoModelForSequenceClassification.from_pretrained` class method or the :meth:`~transformers.TFAutoModelForSequenceClassification.from_config` class method. @@ -1220,7 +1217,7 @@ class TFAutoModelForSequenceClassification(object): class TFAutoModelForQuestionAnswering(object): r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - question answering head---when created with the when created with the + question answering head---when created with the :meth:`~transformers.TFAutoModeForQuestionAnswering.from_pretrained` class method or the :meth:`~transformers.TFAutoModelForQuestionAnswering.from_config` class method. @@ -1317,9 +1314,8 @@ class TFAutoModelForQuestionAnswering(object): class TFAutoModelForTokenClassification: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a token - classification head---when created with the when created with the - :meth:`~transformers.TFAutoModelForTokenClassification.from_pretrained` class method or the - :meth:`~transformers.TFAutoModelForTokenClassification.from_config` class method. + classification head---when created with the :meth:`~transformers.TFAutoModelForTokenClassification.from_pretrained` + class method or the :meth:`~transformers.TFAutoModelForTokenClassification.from_config` class method. This class cannot be instantiated directly using ``__init__()`` (throws an error). """ @@ -1414,7 +1410,7 @@ class TFAutoModelForTokenClassification: class TFAutoModelForMultipleChoice: r""" This is a generic model class that will be instantiated as one of the model classes of the library---with a - multiple choice classification head---when created with the when created with the + multiple choice classification head---when created with the :meth:`~transformers.TFAutoModelForMultipleChoice.from_pretrained` class method or the :meth:`~transformers.TFAutoModelForMultipleChoice.from_config` class method. @@ -1511,8 +1507,8 @@ class TFAutoModelForMultipleChoice: class TFAutoModelForNextSentencePrediction: r""" - This is a generic model class that will be instantiated as one of the model classes of the library---with a - multiple choice classification head---when created with the when created with the + This is a generic model class that will be instantiated as one of the model classes of the library---with a next + sentence prediction head---when created with the :meth:`~transformers.TFAutoModelForNextSentencePrediction.from_pretrained` class method or the :meth:`~transformers.TFAutoModelForNextSentencePrediction.from_config` class method.