From 6241c873cd24551d33cf78cf3df66f7c8b563f8b Mon Sep 17 00:00:00 2001 From: Sylvain Gugger <35901082+sgugger@users.noreply.github.com> Date: Wed, 28 Oct 2020 13:41:56 -0400 Subject: [PATCH] Document the various LM Auto models (#8118) --- docs/source/model_doc/auto.rst | 38 +++++++++++++++++++++++++++++----- 1 file changed, 33 insertions(+), 5 deletions(-) diff --git a/docs/source/model_doc/auto.rst b/docs/source/model_doc/auto.rst index 1faa4b76bf..2859c2186a 100644 --- a/docs/source/model_doc/auto.rst +++ b/docs/source/model_doc/auto.rst @@ -1,4 +1,4 @@ -AutoClasses +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 @@ -46,10 +46,24 @@ AutoModelForPreTraining :members: -AutoModelWithLMHead +AutoModelForCausalLM ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: transformers.AutoModelWithLMHead +.. autoclass:: transformers.AutoModelForCausalLM + :members: + + +AutoModelForMaskedLM +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. autoclass:: transformers.AutoModelForMaskedLM + :members: + + +AutoModelForSeq2SeqLM +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. autoclass:: transformers.AutoModelForSeq2SeqLM :members: @@ -95,10 +109,24 @@ TFAutoModelForPreTraining :members: -TFAutoModelWithLMHead +TFAutoModelForCausalLM ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autoclass:: transformers.TFAutoModelWithLMHead +.. autoclass:: transformers.TFAutoModelForCausalLM + :members: + + +TFAutoModelForMaskedLM +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. autoclass:: transformers.TFAutoModelForMaskedLM + :members: + + +TFAutoModelForSeq2SeqLM +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. autoclass:: transformers.TFAutoModelForSeq2SeqLM :members: