From 927904bc911225c1ea6087c5e24aa77d265bfb9e Mon Sep 17 00:00:00 2001 From: LysandreJik Date: Thu, 26 Sep 2019 08:47:15 -0400 Subject: [PATCH] [doc] pytorch_transformers -> transformers --- docs/source/main_classes/model.rst | 2 +- docs/source/main_classes/processors.rst | 36 ++++++++++++------------- docs/source/model_doc/bert.rst | 16 +++++------ docs/source/model_doc/distilbert.rst | 8 +++--- docs/source/model_doc/gpt.rst | 6 ++--- docs/source/model_doc/gpt2.rst | 6 ++--- docs/source/model_doc/roberta.rst | 6 ++--- docs/source/model_doc/transformerxl.rst | 4 +-- docs/source/model_doc/xlnet.rst | 8 +++--- 9 files changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/source/main_classes/model.rst b/docs/source/main_classes/model.rst index 179ec53d0e..6e3da45bc2 100644 --- a/docs/source/main_classes/model.rst +++ b/docs/source/main_classes/model.rst @@ -17,5 +17,5 @@ The base class ``PreTrainedModel`` implements the common methods for loading/sav ``TFPreTrainedModel`` ~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFPreTrainedModel +.. autoclass:: transformers.TFPreTrainedModel :members: diff --git a/docs/source/main_classes/processors.rst b/docs/source/main_classes/processors.rst index 79bd8ddaac..a85c126956 100644 --- a/docs/source/main_classes/processors.rst +++ b/docs/source/main_classes/processors.rst @@ -8,20 +8,20 @@ Processors ~~~~~~~~~~~~~~~~~~~~~ All processors follow the same architecture which is that of the -:class:`~pytorch_transformers.data.processors.utils.DataProcessor`. The processor returns a list -of :class:`~pytorch_transformers.data.processors.utils.InputExample`. These -:class:`~pytorch_transformers.data.processors.utils.InputExample` can be converted to -:class:`~pytorch_transformers.data.processors.utils.InputFeatures` in order to be fed to the model. +:class:`~transformers.data.processors.utils.DataProcessor`. The processor returns a list +of :class:`~transformers.data.processors.utils.InputExample`. These +:class:`~transformers.data.processors.utils.InputExample` can be converted to +:class:`~transformers.data.processors.utils.InputFeatures` in order to be fed to the model. -.. autoclass:: pytorch_transformers.data.processors.utils.DataProcessor +.. autoclass:: transformers.data.processors.utils.DataProcessor :members: -.. autoclass:: pytorch_transformers.data.processors.utils.InputExample +.. autoclass:: transformers.data.processors.utils.InputExample :members: -.. autoclass:: pytorch_transformers.data.processors.utils.InputFeatures +.. autoclass:: transformers.data.processors.utils.InputFeatures :members: @@ -36,20 +36,20 @@ This library hosts a total of 10 processors for the following tasks: MRPC, MNLI, CoLA, SST2, STSB, QQP, QNLI, RTE and WNLI. Those processors are: - - :class:`~pytorch_transformers.data.processors.utils.MrpcProcessor` - - :class:`~pytorch_transformers.data.processors.utils.MnliProcessor` - - :class:`~pytorch_transformers.data.processors.utils.MnliMismatchedProcessor` - - :class:`~pytorch_transformers.data.processors.utils.Sst2Processor` - - :class:`~pytorch_transformers.data.processors.utils.StsbProcessor` - - :class:`~pytorch_transformers.data.processors.utils.QqpProcessor` - - :class:`~pytorch_transformers.data.processors.utils.QnliProcessor` - - :class:`~pytorch_transformers.data.processors.utils.RteProcessor` - - :class:`~pytorch_transformers.data.processors.utils.WnliProcessor` + - :class:`~transformers.data.processors.utils.MrpcProcessor` + - :class:`~transformers.data.processors.utils.MnliProcessor` + - :class:`~transformers.data.processors.utils.MnliMismatchedProcessor` + - :class:`~transformers.data.processors.utils.Sst2Processor` + - :class:`~transformers.data.processors.utils.StsbProcessor` + - :class:`~transformers.data.processors.utils.QqpProcessor` + - :class:`~transformers.data.processors.utils.QnliProcessor` + - :class:`~transformers.data.processors.utils.RteProcessor` + - :class:`~transformers.data.processors.utils.WnliProcessor` Additionally, the following method can be used to load values from a data file and convert them to a list of -:class:`~pytorch_transformers.data.processors.utils.InputExample`. +:class:`~transformers.data.processors.utils.InputExample`. -.. automethod:: pytorch_transformers.data.processors.glue.glue_convert_examples_to_features +.. automethod:: transformers.data.processors.glue.glue_convert_examples_to_features Example usage ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/model_doc/bert.rst b/docs/source/model_doc/bert.rst index cfc221d381..98b377d0f2 100644 --- a/docs/source/model_doc/bert.rst +++ b/docs/source/model_doc/bert.rst @@ -74,55 +74,55 @@ BERT ``TFBertModel`` ~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFBertModel +.. autoclass:: transformers.TFBertModel :members: ``TFBertForPreTraining`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFBertForPreTraining +.. autoclass:: transformers.TFBertForPreTraining :members: ``TFBertForMaskedLM`` ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFBertForMaskedLM +.. autoclass:: transformers.TFBertForMaskedLM :members: ``TFBertForNextSentencePrediction`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFBertForNextSentencePrediction +.. autoclass:: transformers.TFBertForNextSentencePrediction :members: ``TFBertForSequenceClassification`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFBertForSequenceClassification +.. autoclass:: transformers.TFBertForSequenceClassification :members: ``TFBertForMultipleChoice`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFBertForMultipleChoice +.. autoclass:: transformers.TFBertForMultipleChoice :members: ``TFBertForTokenClassification`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFBertForTokenClassification +.. autoclass:: transformers.TFBertForTokenClassification :members: ``TFBertForQuestionAnswering`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFBertForQuestionAnswering +.. autoclass:: transformers.TFBertForQuestionAnswering :members: diff --git a/docs/source/model_doc/distilbert.rst b/docs/source/model_doc/distilbert.rst index 6d0fdcd4f3..0eabdabc68 100644 --- a/docs/source/model_doc/distilbert.rst +++ b/docs/source/model_doc/distilbert.rst @@ -45,26 +45,26 @@ DistilBERT ``TFDistilBertModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFDistilBertModel +.. autoclass:: transformers.TFDistilBertModel :members: ``TFDistilBertForMaskedLM`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFDistilBertForMaskedLM +.. autoclass:: transformers.TFDistilBertForMaskedLM :members: ``TFDistilBertForSequenceClassification`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFDistilBertForSequenceClassification +.. autoclass:: transformers.TFDistilBertForSequenceClassification :members: ``TFDistilBertForQuestionAnswering`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFDistilBertForQuestionAnswering +.. autoclass:: transformers.TFDistilBertForQuestionAnswering :members: diff --git a/docs/source/model_doc/gpt.rst b/docs/source/model_doc/gpt.rst index dd6e314b8f..d8281e8aff 100644 --- a/docs/source/model_doc/gpt.rst +++ b/docs/source/model_doc/gpt.rst @@ -39,19 +39,19 @@ OpenAI GPT ``TFOpenAIGPTModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFOpenAIGPTModel +.. autoclass:: transformers.TFOpenAIGPTModel :members: ``TFOpenAIGPTLMHeadModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFOpenAIGPTLMHeadModel +.. autoclass:: transformers.TFOpenAIGPTLMHeadModel :members: ``TFOpenAIGPTDoubleHeadsModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFOpenAIGPTDoubleHeadsModel +.. autoclass:: transformers.TFOpenAIGPTDoubleHeadsModel :members: diff --git a/docs/source/model_doc/gpt2.rst b/docs/source/model_doc/gpt2.rst index 19b435fc03..bd76700a9d 100644 --- a/docs/source/model_doc/gpt2.rst +++ b/docs/source/model_doc/gpt2.rst @@ -39,19 +39,19 @@ OpenAI GPT2 ``TFGPT2Model`` ~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFGPT2Model +.. autoclass:: transformers.TFGPT2Model :members: ``TFGPT2LMHeadModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFGPT2LMHeadModel +.. autoclass:: transformers.TFGPT2LMHeadModel :members: ``TFGPT2DoubleHeadsModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFGPT2DoubleHeadsModel +.. autoclass:: transformers.TFGPT2DoubleHeadsModel :members: diff --git a/docs/source/model_doc/roberta.rst b/docs/source/model_doc/roberta.rst index ed839456af..105cb85a8d 100644 --- a/docs/source/model_doc/roberta.rst +++ b/docs/source/model_doc/roberta.rst @@ -39,19 +39,19 @@ RoBERTa ``TFRobertaModel`` ~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFRobertaModel +.. autoclass:: transformers.TFRobertaModel :members: ``TFRobertaForMaskedLM`` ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFRobertaForMaskedLM +.. autoclass:: transformers.TFRobertaForMaskedLM :members: ``TFRobertaForSequenceClassification`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFRobertaForSequenceClassification +.. autoclass:: transformers.TFRobertaForSequenceClassification :members: diff --git a/docs/source/model_doc/transformerxl.rst b/docs/source/model_doc/transformerxl.rst index 243726aa95..4d018c0696 100644 --- a/docs/source/model_doc/transformerxl.rst +++ b/docs/source/model_doc/transformerxl.rst @@ -33,12 +33,12 @@ Transformer XL ``TFTransfoXLModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFTransfoXLModel +.. autoclass:: transformers.TFTransfoXLModel :members: ``TFTransfoXLLMHeadModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFTransfoXLLMHeadModel +.. autoclass:: transformers.TFTransfoXLLMHeadModel :members: diff --git a/docs/source/model_doc/xlnet.rst b/docs/source/model_doc/xlnet.rst index 197710f2f9..4005ce3a0a 100644 --- a/docs/source/model_doc/xlnet.rst +++ b/docs/source/model_doc/xlnet.rst @@ -46,26 +46,26 @@ XLNet ``TFXLNetModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFXLNetModel +.. autoclass:: transformers.TFXLNetModel :members: ``TFXLNetLMHeadModel`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFXLNetLMHeadModel +.. autoclass:: transformers.TFXLNetLMHeadModel :members: ``TFXLNetForSequenceClassification`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFXLNetForSequenceClassification +.. autoclass:: transformers.TFXLNetForSequenceClassification :members: ``TFXLNetForQuestionAnsweringSimple`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: pytorch_transformers.TFXLNetForQuestionAnsweringSimple +.. autoclass:: transformers.TFXLNetForQuestionAnsweringSimple :members: