Commit 927904bc authored by LysandreJik's avatar LysandreJik
Browse files

[doc] pytorch_transformers -> transformers

parent 294edfd8
...@@ -17,5 +17,5 @@ The base class ``PreTrainedModel`` implements the common methods for loading/sav ...@@ -17,5 +17,5 @@ The base class ``PreTrainedModel`` implements the common methods for loading/sav
``TFPreTrainedModel`` ``TFPreTrainedModel``
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFPreTrainedModel .. autoclass:: transformers.TFPreTrainedModel
:members: :members:
...@@ -8,20 +8,20 @@ Processors ...@@ -8,20 +8,20 @@ Processors
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
All processors follow the same architecture which is that of the All processors follow the same architecture which is that of the
:class:`~pytorch_transformers.data.processors.utils.DataProcessor`. The processor returns a list :class:`~transformers.data.processors.utils.DataProcessor`. The processor returns a list
of :class:`~pytorch_transformers.data.processors.utils.InputExample`. These of :class:`~transformers.data.processors.utils.InputExample`. These
:class:`~pytorch_transformers.data.processors.utils.InputExample` can be converted to :class:`~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.InputFeatures` in order to be fed to the model.
.. autoclass:: pytorch_transformers.data.processors.utils.DataProcessor .. autoclass:: transformers.data.processors.utils.DataProcessor
:members: :members:
.. autoclass:: pytorch_transformers.data.processors.utils.InputExample .. autoclass:: transformers.data.processors.utils.InputExample
:members: :members:
.. autoclass:: pytorch_transformers.data.processors.utils.InputFeatures .. autoclass:: transformers.data.processors.utils.InputFeatures
:members: :members:
...@@ -36,20 +36,20 @@ This library hosts a total of 10 processors for the following tasks: MRPC, MNLI, ...@@ -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. CoLA, SST2, STSB, QQP, QNLI, RTE and WNLI.
Those processors are: Those processors are:
- :class:`~pytorch_transformers.data.processors.utils.MrpcProcessor` - :class:`~transformers.data.processors.utils.MrpcProcessor`
- :class:`~pytorch_transformers.data.processors.utils.MnliProcessor` - :class:`~transformers.data.processors.utils.MnliProcessor`
- :class:`~pytorch_transformers.data.processors.utils.MnliMismatchedProcessor` - :class:`~transformers.data.processors.utils.MnliMismatchedProcessor`
- :class:`~pytorch_transformers.data.processors.utils.Sst2Processor` - :class:`~transformers.data.processors.utils.Sst2Processor`
- :class:`~pytorch_transformers.data.processors.utils.StsbProcessor` - :class:`~transformers.data.processors.utils.StsbProcessor`
- :class:`~pytorch_transformers.data.processors.utils.QqpProcessor` - :class:`~transformers.data.processors.utils.QqpProcessor`
- :class:`~pytorch_transformers.data.processors.utils.QnliProcessor` - :class:`~transformers.data.processors.utils.QnliProcessor`
- :class:`~pytorch_transformers.data.processors.utils.RteProcessor` - :class:`~transformers.data.processors.utils.RteProcessor`
- :class:`~pytorch_transformers.data.processors.utils.WnliProcessor` - :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 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 Example usage
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
......
...@@ -74,55 +74,55 @@ BERT ...@@ -74,55 +74,55 @@ BERT
``TFBertModel`` ``TFBertModel``
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFBertModel .. autoclass:: transformers.TFBertModel
:members: :members:
``TFBertForPreTraining`` ``TFBertForPreTraining``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFBertForPreTraining .. autoclass:: transformers.TFBertForPreTraining
:members: :members:
``TFBertForMaskedLM`` ``TFBertForMaskedLM``
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFBertForMaskedLM .. autoclass:: transformers.TFBertForMaskedLM
:members: :members:
``TFBertForNextSentencePrediction`` ``TFBertForNextSentencePrediction``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFBertForNextSentencePrediction .. autoclass:: transformers.TFBertForNextSentencePrediction
:members: :members:
``TFBertForSequenceClassification`` ``TFBertForSequenceClassification``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFBertForSequenceClassification .. autoclass:: transformers.TFBertForSequenceClassification
:members: :members:
``TFBertForMultipleChoice`` ``TFBertForMultipleChoice``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFBertForMultipleChoice .. autoclass:: transformers.TFBertForMultipleChoice
:members: :members:
``TFBertForTokenClassification`` ``TFBertForTokenClassification``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFBertForTokenClassification .. autoclass:: transformers.TFBertForTokenClassification
:members: :members:
``TFBertForQuestionAnswering`` ``TFBertForQuestionAnswering``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFBertForQuestionAnswering .. autoclass:: transformers.TFBertForQuestionAnswering
:members: :members:
...@@ -45,26 +45,26 @@ DistilBERT ...@@ -45,26 +45,26 @@ DistilBERT
``TFDistilBertModel`` ``TFDistilBertModel``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFDistilBertModel .. autoclass:: transformers.TFDistilBertModel
:members: :members:
``TFDistilBertForMaskedLM`` ``TFDistilBertForMaskedLM``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFDistilBertForMaskedLM .. autoclass:: transformers.TFDistilBertForMaskedLM
:members: :members:
``TFDistilBertForSequenceClassification`` ``TFDistilBertForSequenceClassification``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFDistilBertForSequenceClassification .. autoclass:: transformers.TFDistilBertForSequenceClassification
:members: :members:
``TFDistilBertForQuestionAnswering`` ``TFDistilBertForQuestionAnswering``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFDistilBertForQuestionAnswering .. autoclass:: transformers.TFDistilBertForQuestionAnswering
:members: :members:
...@@ -39,19 +39,19 @@ OpenAI GPT ...@@ -39,19 +39,19 @@ OpenAI GPT
``TFOpenAIGPTModel`` ``TFOpenAIGPTModel``
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFOpenAIGPTModel .. autoclass:: transformers.TFOpenAIGPTModel
:members: :members:
``TFOpenAIGPTLMHeadModel`` ``TFOpenAIGPTLMHeadModel``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFOpenAIGPTLMHeadModel .. autoclass:: transformers.TFOpenAIGPTLMHeadModel
:members: :members:
``TFOpenAIGPTDoubleHeadsModel`` ``TFOpenAIGPTDoubleHeadsModel``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFOpenAIGPTDoubleHeadsModel .. autoclass:: transformers.TFOpenAIGPTDoubleHeadsModel
:members: :members:
...@@ -39,19 +39,19 @@ OpenAI GPT2 ...@@ -39,19 +39,19 @@ OpenAI GPT2
``TFGPT2Model`` ``TFGPT2Model``
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFGPT2Model .. autoclass:: transformers.TFGPT2Model
:members: :members:
``TFGPT2LMHeadModel`` ``TFGPT2LMHeadModel``
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFGPT2LMHeadModel .. autoclass:: transformers.TFGPT2LMHeadModel
:members: :members:
``TFGPT2DoubleHeadsModel`` ``TFGPT2DoubleHeadsModel``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFGPT2DoubleHeadsModel .. autoclass:: transformers.TFGPT2DoubleHeadsModel
:members: :members:
...@@ -39,19 +39,19 @@ RoBERTa ...@@ -39,19 +39,19 @@ RoBERTa
``TFRobertaModel`` ``TFRobertaModel``
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFRobertaModel .. autoclass:: transformers.TFRobertaModel
:members: :members:
``TFRobertaForMaskedLM`` ``TFRobertaForMaskedLM``
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFRobertaForMaskedLM .. autoclass:: transformers.TFRobertaForMaskedLM
:members: :members:
``TFRobertaForSequenceClassification`` ``TFRobertaForSequenceClassification``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFRobertaForSequenceClassification .. autoclass:: transformers.TFRobertaForSequenceClassification
:members: :members:
...@@ -33,12 +33,12 @@ Transformer XL ...@@ -33,12 +33,12 @@ Transformer XL
``TFTransfoXLModel`` ``TFTransfoXLModel``
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFTransfoXLModel .. autoclass:: transformers.TFTransfoXLModel
:members: :members:
``TFTransfoXLLMHeadModel`` ``TFTransfoXLLMHeadModel``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFTransfoXLLMHeadModel .. autoclass:: transformers.TFTransfoXLLMHeadModel
:members: :members:
...@@ -46,26 +46,26 @@ XLNet ...@@ -46,26 +46,26 @@ XLNet
``TFXLNetModel`` ``TFXLNetModel``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFXLNetModel .. autoclass:: transformers.TFXLNetModel
:members: :members:
``TFXLNetLMHeadModel`` ``TFXLNetLMHeadModel``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFXLNetLMHeadModel .. autoclass:: transformers.TFXLNetLMHeadModel
:members: :members:
``TFXLNetForSequenceClassification`` ``TFXLNetForSequenceClassification``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFXLNetForSequenceClassification .. autoclass:: transformers.TFXLNetForSequenceClassification
:members: :members:
``TFXLNetForQuestionAnsweringSimple`` ``TFXLNetForQuestionAnsweringSimple``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: pytorch_transformers.TFXLNetForQuestionAnsweringSimple .. autoclass:: transformers.TFXLNetForQuestionAnsweringSimple
:members: :members:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment