Convert last rst file (#14952)

b2f50025 · Sylvain Gugger · GitHub · 87e6e4fe · b2f50025 · 87e6e4fe
Unverified Commit b2f50025 authored Dec 27, 2021 by Sylvain Gugger Committed by GitHub Dec 27, 2021
Show whitespace changes
Inline Side-by-side

Showing with 243 additions and 384 deletions

docs/source/model_doc/auto.mdx docs/source/model_doc/auto.mdx +243 -0

docs/source/model_doc/auto.rst docs/source/model_doc/auto.rst +0 -384

No files found.
--- a/docs/source/model_doc/auto.mdx
+++ b/docs/source/model_doc/auto.mdx
+<!--Copyright 2020 The HuggingFace Team. All rights reserved.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+# Auto Classes
+In many cases, the architecture you want to use can be guessed from the name or the path of the pretrained model you
+are supplying to the `from_pretrained()` method. AutoClasses are here to do this job for you so that you
+automatically retrieve the relevant model given the name/path to the pretrained weights/config/vocabulary.
+Instantiating one of [`AutoConfig`], [`AutoModel`], and
+[`AutoTokenizer`] will directly create a class of the relevant architecture. For instance
+```python
+model = AutoModel.from_pretrained('bert-base-cased')
+```
+will create a model that is an instance of [`BertModel`].
+There is one class of `AutoModel` for each task, and for each backend (PyTorch, TensorFlow, or Flax).
+## Extending the Auto Classes
+Each of the auto classes has a method to be extended with your custom classes. For instance, if you have defined a
+custom class of model `NewModel`, make sure you have a `NewModelConfig` then you can add those to the auto
+classes like this:
+```python
+from transformers import AutoConfig, AutoModel
+AutoConfig.register("new-model", NewModelConfig)
+AutoModel.register(NewModelConfig, NewModel)
+```
+You will then be able to use the auto classes like you would usually do!
+<Tip warning={true}>
+If your `NewModelConfig` is a subclass of [`~transformer.PretrainedConfig`], make sure its
+`model_type` attribute is set to the same key you use when registering the config (here `"new-model"`).
+Likewise, if your `NewModel` is a subclass of [`PreTrainedModel`], make sure its
+`config_class` attribute is set to the same class you use when registering the model (here
+`NewModelConfig`).
+</Tip>
+## AutoConfig
+[[autodoc]] AutoConfig
+## AutoTokenizer
+[[autodoc]] AutoTokenizer
+## AutoFeatureExtractor
+[[autodoc]] AutoFeatureExtractor
+## AutoProcessor
+[[autodoc]] AutoProcessor
+## AutoModel
+[[autodoc]] AutoModel
+## AutoModelForPreTraining
+[[autodoc]] AutoModelForPreTraining
+## AutoModelForCausalLM
+[[autodoc]] AutoModelForCausalLM
+## AutoModelForMaskedLM
+[[autodoc]] AutoModelForMaskedLM
+## AutoModelForSeq2SeqLM
+[[autodoc]] AutoModelForSeq2SeqLM
+## AutoModelForSequenceClassification
+[[autodoc]] AutoModelForSequenceClassification
+## AutoModelForMultipleChoice
+[[autodoc]] AutoModelForMultipleChoice
+## AutoModelForNextSentencePrediction
+[[autodoc]] AutoModelForNextSentencePrediction
+## AutoModelForTokenClassification
+[[autodoc]] AutoModelForTokenClassification
+## AutoModelForQuestionAnswering
+[[autodoc]] AutoModelForQuestionAnswering
+## AutoModelForTableQuestionAnswering
+[[autodoc]] AutoModelForTableQuestionAnswering
+## AutoModelForImageClassification
+[[autodoc]] AutoModelForImageClassification
+## AutoModelForVision2Seq
+[[autodoc]] AutoModelForVision2Seq
+## AutoModelForAudioClassification
+[[autodoc]] AutoModelForAudioClassification
+## AutoModelForAudioFrameClassification
+[[autodoc]] AutoModelForAudioFrameClassification
+## AutoModelForCTC
+[[autodoc]] AutoModelForCTC
+## AutoModelForSpeechSeq2Seq
+[[autodoc]] AutoModelForSpeechSeq2Seq
+## AutoModelForAudioXVector
+[[autodoc]] AutoModelForAudioXVector
+## AutoModelForObjectDetection
+[[autodoc]] AutoModelForObjectDetection
+## AutoModelForImageSegmentation
+[[autodoc]] AutoModelForImageSegmentation
+## TFAutoModel
+[[autodoc]] TFAutoModel
+## TFAutoModelForPreTraining
+[[autodoc]] TFAutoModelForPreTraining
+## TFAutoModelForCausalLM
+[[autodoc]] TFAutoModelForCausalLM
+## TFAutoModelForImageClassification
+[[autodoc]] TFAutoModelForImageClassification
+## TFAutoModelForMaskedLM
+[[autodoc]] TFAutoModelForMaskedLM
+## TFAutoModelForSeq2SeqLM
+[[autodoc]] TFAutoModelForSeq2SeqLM
+## TFAutoModelForSequenceClassification
+[[autodoc]] TFAutoModelForSequenceClassification
+## TFAutoModelForMultipleChoice
+[[autodoc]] TFAutoModelForMultipleChoice
+## TFAutoModelForTableQuestionAnswering
+[[autodoc]] TFAutoModelForTableQuestionAnswering
+## TFAutoModelForTokenClassification
+[[autodoc]] TFAutoModelForTokenClassification
+## TFAutoModelForQuestionAnswering
+[[autodoc]] TFAutoModelForQuestionAnswering
+## FlaxAutoModel
+[[autodoc]] FlaxAutoModel
+## FlaxAutoModelForCausalLM
+[[autodoc]] FlaxAutoModelForCausalLM
+## FlaxAutoModelForPreTraining
+[[autodoc]] FlaxAutoModelForPreTraining
+## FlaxAutoModelForMaskedLM
+[[autodoc]] FlaxAutoModelForMaskedLM
+## FlaxAutoModelForSeq2SeqLM
+[[autodoc]] FlaxAutoModelForSeq2SeqLM
+## FlaxAutoModelForSequenceClassification
+[[autodoc]] FlaxAutoModelForSequenceClassification
+## FlaxAutoModelForQuestionAnswering
+[[autodoc]] FlaxAutoModelForQuestionAnswering
+## FlaxAutoModelForTokenClassification
+[[autodoc]] FlaxAutoModelForTokenClassification
+## FlaxAutoModelForMultipleChoice
+[[autodoc]] FlaxAutoModelForMultipleChoice
+## FlaxAutoModelForNextSentencePrediction
+[[autodoc]] FlaxAutoModelForNextSentencePrediction
+## FlaxAutoModelForImageClassification
+[[autodoc]] FlaxAutoModelForImageClassification
+## FlaxAutoModelForVision2Seq
+[[autodoc]] FlaxAutoModelForVision2Seq
--- a/docs/source/model_doc/auto.rst
+++ b/docs/source/model_doc/auto.rst
-.. 
-    Copyright 2020 The HuggingFace Team. All rights reserved.
-    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
-    the License. You may obtain a copy of the License at
-        http://www.apache.org/licenses/LICENSE-2.0
-    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
-    an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
-    specific language governing permissions and limitations under the License.
-Auto Classes
-----------------------------------------------------------------------------------------------------------------------
-In many cases, the architecture you want to use can be guessed from the name or the path of the pretrained model you
-are supplying to the :obj:`from_pretrained()` method. AutoClasses are here to do this job for you so that you
-automatically retrieve the relevant model given the name/path to the pretrained weights/config/vocabulary.
-Instantiating one of :class:`~transformers.AutoConfig`, :class:`~transformers.AutoModel`, and
-:class:`~transformers.AutoTokenizer` will directly create a class of the relevant architecture. For instance
-.. code-block:: python
-    model = AutoModel.from_pretrained('bert-base-cased')
-will create a model that is an instance of :class:`~transformers.BertModel`.
-There is one class of :obj:`AutoModel` for each task, and for each backend (PyTorch, TensorFlow, or Flax).
-Extending the Auto Classes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Each of the auto classes has a method to be extended with your custom classes. For instance, if you have defined a
-custom class of model :obj:`NewModel`, make sure you have a :obj:`NewModelConfig` then you can add those to the auto
-classes like this:
-.. code-block::
-    from transformers import AutoConfig, AutoModel
-    AutoConfig.register("new-model", NewModelConfig)
-    AutoModel.register(NewModelConfig, NewModel)
-You will then be able to use the auto classes like you would usually do!
-.. warning::
-    If your :obj:`NewModelConfig` is a subclass of :class:`~transformer.PretrainedConfig`, make sure its
-    :obj:`model_type` attribute is set to the same key you use when registering the config (here :obj:`"new-model"`).
-    Likewise, if your :obj:`NewModel` is a subclass of :class:`~transformers.PreTrainedModel`, make sure its
-    :obj:`config_class` attribute is set to the same class you use when registering the model (here
-    :obj:`NewModelConfig`).
-AutoConfig
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoConfig
-    :members:
-AutoTokenizer
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoTokenizer
-    :members:
-AutoFeatureExtractor
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoFeatureExtractor
-    :members:
-AutoProcessor
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoProcessor
-    :members:
-AutoModel
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModel
-    :members:
-AutoModelForPreTraining
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForPreTraining
-    :members:
-AutoModelForCausalLM
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForCausalLM
-    :members:
-AutoModelForMaskedLM
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForMaskedLM
-    :members:
-AutoModelForSeq2SeqLM
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForSeq2SeqLM
-    :members:
-AutoModelForSequenceClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForSequenceClassification
-    :members:
-AutoModelForMultipleChoice
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForMultipleChoice
-    :members:
-AutoModelForNextSentencePrediction
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForNextSentencePrediction
-    :members:
-AutoModelForTokenClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForTokenClassification
-    :members:
-AutoModelForQuestionAnswering
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForQuestionAnswering
-    :members:
-AutoModelForTableQuestionAnswering
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForTableQuestionAnswering
-    :members:
-AutoModelForImageClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForImageClassification
-    :members:
-AutoModelForVision2Seq
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForVision2Seq
-    :members:
-AutoModelForAudioClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForAudioClassification
-    :members:
-AutoModelForAudioFrameClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForAudioFrameClassification
-    :members:
-AutoModelForCTC
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForCTC
-    :members:
-AutoModelForSpeechSeq2Seq
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForSpeechSeq2Seq
-    :members:
-AutoModelForAudioXVector
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForAudioXVector
-    :members:
-AutoModelForObjectDetection
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForObjectDetection
-    :members:
-AutoModelForImageSegmentation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.AutoModelForImageSegmentation
-    :members:
-TFAutoModel
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModel
-    :members:
-TFAutoModelForPreTraining
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForPreTraining
-    :members:
-TFAutoModelForCausalLM
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForCausalLM
-    :members:
-TFAutoModelForImageClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForImageClassification
-    :members:
-TFAutoModelForMaskedLM
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForMaskedLM
-    :members:
-TFAutoModelForSeq2SeqLM
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForSeq2SeqLM
-    :members:
-TFAutoModelForSequenceClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForSequenceClassification
-    :members:
-TFAutoModelForMultipleChoice
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForMultipleChoice
-    :members:
-TFAutoModelForTableQuestionAnswering
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForTableQuestionAnswering
-    :members:
-TFAutoModelForTokenClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForTokenClassification
-    :members:
-TFAutoModelForQuestionAnswering
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.TFAutoModelForQuestionAnswering
-    :members:
-FlaxAutoModel
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModel
-    :members:
-FlaxAutoModelForCausalLM
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForCausalLM
-    :members:
-FlaxAutoModelForPreTraining
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForPreTraining
-    :members:
-FlaxAutoModelForMaskedLM
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForMaskedLM
-    :members:
-FlaxAutoModelForSeq2SeqLM
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForSeq2SeqLM
-    :members:
-FlaxAutoModelForSequenceClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForSequenceClassification
-    :members:
-FlaxAutoModelForQuestionAnswering
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForQuestionAnswering
-    :members:
-FlaxAutoModelForTokenClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForTokenClassification
-    :members:
-FlaxAutoModelForMultipleChoice
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForMultipleChoice
-    :members:
-FlaxAutoModelForNextSentencePrediction
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForNextSentencePrediction
-    :members:
-FlaxAutoModelForImageClassification
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForImageClassification
-    :members:
-FlaxAutoModelForVision2Seq
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: transformers.FlaxAutoModelForVision2Seq
-    :members: