From 68aaf83ec9521103517925ad55a37ab2c02a185b Mon Sep 17 00:00:00 2001 From: Steven Date: Fri, 2 Dec 2022 11:44:59 -0800 Subject: [PATCH 1/3] split autoclasses on modality --- docs/source/en/model_doc/auto.mdx | 230 ++++++++++++++++-------------- 1 file changed, 123 insertions(+), 107 deletions(-) diff --git a/docs/source/en/model_doc/auto.mdx b/docs/source/en/model_doc/auto.mdx index 79ad20bd8045..60f50f6cc568 100644 --- a/docs/source/en/model_doc/auto.mdx +++ b/docs/source/en/model_doc/auto.mdx @@ -78,222 +78,238 @@ Likewise, if your `NewModel` is a subclass of [`PreTrainedModel`], make sure its [[autodoc]] AutoModel +## TFAutoModel + +[[autodoc]] TFAutoModel + +## FlaxAutoModel + +[[autodoc]] FlaxAutoModel + ## AutoModelForPreTraining [[autodoc]] AutoModelForPreTraining -## AutoModelForCausalLM +## TFAutoModelForPreTraining -[[autodoc]] AutoModelForCausalLM +[[autodoc]] TFAutoModelForPreTraining -## AutoModelForDepthEstimation +## FlaxAutoModelForPreTraining -[[autodoc]] AutoModelForDepthEstimation +[[autodoc]] FlaxAutoModelForPreTraining -## AutoModelForMaskedLM +## Natural Language Processing -[[autodoc]] AutoModelForMaskedLM +[`AutoModel`], [`TFAutoModel`], and [`FlaxAutoModel`] are available for the following natural language processing tasks. -## AutoModelForSeq2SeqLM +### AutoModelForCausalLM -[[autodoc]] AutoModelForSeq2SeqLM +[[autodoc]] AutoModelForCausalLM -## AutoModelForSequenceClassification +### TFAutoModelForCausalLM -[[autodoc]] AutoModelForSequenceClassification +[[autodoc]] TFAutoModelForCausalLM -## AutoModelForMultipleChoice +### FlaxAutoModelForCausalLM -[[autodoc]] AutoModelForMultipleChoice +[[autodoc]] FlaxAutoModelForCausalLM -## AutoModelForNextSentencePrediction +### AutoModelForMaskedLM -[[autodoc]] AutoModelForNextSentencePrediction +[[autodoc]] AutoModelForMaskedLM -## AutoModelForTokenClassification +### TFAutoModelForMaskedLM -[[autodoc]] AutoModelForTokenClassification +[[autodoc]] TFAutoModelForMaskedLM -## AutoModelForQuestionAnswering +### FlaxAutoModelForMaskedLM -[[autodoc]] AutoModelForQuestionAnswering +[[autodoc]] FlaxAutoModelForMaskedLM -## AutoModelForTableQuestionAnswering +### AutoModelForSeq2SeqLM -[[autodoc]] AutoModelForTableQuestionAnswering +[[autodoc]] AutoModelForSeq2SeqLM -## AutoModelForDocumentQuestionAnswering +### TFAutoModelForSeq2SeqLM -[[autodoc]] AutoModelForDocumentQuestionAnswering +[[autodoc]] TFAutoModelForSeq2SeqLM -## AutoModelForImageClassification +### FlaxAutoModelForSeq2SeqLM -[[autodoc]] AutoModelForImageClassification +[[autodoc]] FlaxAutoModelForSeq2SeqLM -## AutoModelForVideoClassification +### AutoModelForSequenceClassification -[[autodoc]] AutoModelForVideoClassification +[[autodoc]] AutoModelForSequenceClassification -## AutoModelForVision2Seq +### TFAutoModelForSequenceClassification -[[autodoc]] AutoModelForVision2Seq +[[autodoc]] TFAutoModelForSequenceClassification -## AutoModelForVisualQuestionAnswering +### FlaxAutoModelForSequenceClassification -[[autodoc]] AutoModelForVisualQuestionAnswering +[[autodoc]] FlaxAutoModelForSequenceClassification -## AutoModelForAudioClassification +### AutoModelForMultipleChoice -[[autodoc]] AutoModelForAudioClassification +[[autodoc]] AutoModelForMultipleChoice -## AutoModelForAudioFrameClassification +### TFAutoModelForMultipleChoice -[[autodoc]] AutoModelForAudioFrameClassification +[[autodoc]] TFAutoModelForMultipleChoice -## AutoModelForCTC +### FlaxAutoModelForMultipleChoice -[[autodoc]] AutoModelForCTC +[[autodoc]] FlaxAutoModelForMultipleChoice -## AutoModelForSpeechSeq2Seq +### AutoModelForNextSentencePrediction -[[autodoc]] AutoModelForSpeechSeq2Seq +[[autodoc]] AutoModelForNextSentencePrediction -## AutoModelForAudioXVector +### TFAutoModelForNextSentencePrediction -[[autodoc]] AutoModelForAudioXVector +[[autodoc]] TFAutoModelForNextSentencePrediction -## AutoModelForMaskedImageModeling +### FlaxAutoModelForNextSentencePrediction -[[autodoc]] AutoModelForMaskedImageModeling +[[autodoc]] FlaxAutoModelForNextSentencePrediction -## AutoModelForObjectDetection +### AutoModelForTokenClassification -[[autodoc]] AutoModelForObjectDetection +[[autodoc]] AutoModelForTokenClassification -## AutoModelForImageSegmentation +### TFAutoModelForTokenClassification -[[autodoc]] AutoModelForImageSegmentation +[[autodoc]] TFAutoModelForTokenClassification -## AutoModelForSemanticSegmentation +### FlaxAutoModelForTokenClassification -[[autodoc]] AutoModelForSemanticSegmentation +[[autodoc]] FlaxAutoModelForTokenClassification -## AutoModelForInstanceSegmentation +### AutoModelForQuestionAnswering -[[autodoc]] AutoModelForInstanceSegmentation +[[autodoc]] AutoModelForQuestionAnswering -## AutoModelForZeroShotObjectDetection +### TFAutoModelForQuestionAnswering -[[autodoc]] AutoModelForZeroShotObjectDetection +[[autodoc]] TFAutoModelForQuestionAnswering -## TFAutoModel +### FlaxAutoModelForQuestionAnswering -[[autodoc]] TFAutoModel +[[autodoc]] FlaxAutoModelForQuestionAnswering -## TFAutoModelForPreTraining +### AutoModelForTableQuestionAnswering -[[autodoc]] TFAutoModelForPreTraining +[[autodoc]] AutoModelForTableQuestionAnswering -## TFAutoModelForCausalLM +### TFAutoModelForTableQuestionAnswering -[[autodoc]] TFAutoModelForCausalLM +[[autodoc]] TFAutoModelForTableQuestionAnswering -## TFAutoModelForImageClassification +## Computer vision -[[autodoc]] TFAutoModelForImageClassification +[`AutoModel`], [`TFAutoModel`], and [`FlaxAutoModel`] are available for the following computer vision tasks. -## TFAutoModelForSemanticSegmentation +### AutoModelForDepthEstimation -[[autodoc]] TFAutoModelForSemanticSegmentation +[[autodoc]] AutoModelForDepthEstimation -## TFAutoModelForMaskedLM +### AutoModelForImageClassification -[[autodoc]] TFAutoModelForMaskedLM +[[autodoc]] AutoModelForImageClassification -## TFAutoModelForSeq2SeqLM +### TFAutoModelForImageClassification -[[autodoc]] TFAutoModelForSeq2SeqLM +[[autodoc]] TFAutoModelForImageClassification -## TFAutoModelForSequenceClassification +### FlaxAutoModelForImageClassification -[[autodoc]] TFAutoModelForSequenceClassification +[[autodoc]] FlaxAutoModelForImageClassification -## TFAutoModelForMultipleChoice +### AutoModelForVideoClassification -[[autodoc]] TFAutoModelForMultipleChoice +[[autodoc]] AutoModelForVideoClassification -## TFAutoModelForNextSentencePrediction +### AutoModelForMaskedImageModeling -[[autodoc]] TFAutoModelForNextSentencePrediction +[[autodoc]] AutoModelForMaskedImageModeling -## TFAutoModelForTableQuestionAnswering +### AutoModelForObjectDetection -[[autodoc]] TFAutoModelForTableQuestionAnswering +[[autodoc]] AutoModelForObjectDetection -## TFAutoModelForDocumentQuestionAnswering +### AutoModelForImageSegmentation -[[autodoc]] TFAutoModelForDocumentQuestionAnswering +[[autodoc]] AutoModelForImageSegmentation -## TFAutoModelForTokenClassification +### AutoModelForSemanticSegmentation -[[autodoc]] TFAutoModelForTokenClassification +[[autodoc]] AutoModelForSemanticSegmentation -## TFAutoModelForQuestionAnswering +### TFAutoModelForSemanticSegmentation -[[autodoc]] TFAutoModelForQuestionAnswering +[[autodoc]] TFAutoModelForSemanticSegmentation -## TFAutoModelForVision2Seq +### AutoModelForInstanceSegmentation -[[autodoc]] TFAutoModelForVision2Seq +[[autodoc]] AutoModelForInstanceSegmentation -## TFAutoModelForSpeechSeq2Seq +### AutoModelForZeroShotObjectDetection -[[autodoc]] TFAutoModelForSpeechSeq2Seq +[[autodoc]] AutoModelForZeroShotObjectDetection -## FlaxAutoModel +## Audio -[[autodoc]] FlaxAutoModel +[`AutoModel`] and [`TFAutoModel`] are available for the following audio tasks. -## FlaxAutoModelForCausalLM +### AutoModelForAudioClassification -[[autodoc]] FlaxAutoModelForCausalLM +[[autodoc]] AutoModelForAudioClassification -## FlaxAutoModelForPreTraining +### AutoModelForAudioFrameClassification -[[autodoc]] FlaxAutoModelForPreTraining +[[autodoc]] AutoModelForAudioFrameClassification -## FlaxAutoModelForMaskedLM +### AutoModelForCTC -[[autodoc]] FlaxAutoModelForMaskedLM +[[autodoc]] AutoModelForCTC -## FlaxAutoModelForSeq2SeqLM +### AutoModelForSpeechSeq2Seq -[[autodoc]] FlaxAutoModelForSeq2SeqLM +[[autodoc]] AutoModelForSpeechSeq2Seq -## FlaxAutoModelForSequenceClassification +### TFAutoModelForSpeechSeq2Seq -[[autodoc]] FlaxAutoModelForSequenceClassification +[[autodoc]] TFAutoModelForSpeechSeq2Seq -## FlaxAutoModelForQuestionAnswering +### AutoModelForAudioXVector -[[autodoc]] FlaxAutoModelForQuestionAnswering +[[autodoc]] AutoModelForAudioXVector -## FlaxAutoModelForTokenClassification +## Multimodal -[[autodoc]] FlaxAutoModelForTokenClassification +[`AutoModel`], [`TFAutoModel`], and [`FlaxAutoModel`] are available for the following multimodal tasks. -## FlaxAutoModelForMultipleChoice +### AutoModelForDocumentQuestionAnswering -[[autodoc]] FlaxAutoModelForMultipleChoice +[[autodoc]] AutoModelForDocumentQuestionAnswering -## FlaxAutoModelForNextSentencePrediction +### TFAutoModelForDocumentQuestionAnswering -[[autodoc]] FlaxAutoModelForNextSentencePrediction +[[autodoc]] TFAutoModelForDocumentQuestionAnswering -## FlaxAutoModelForImageClassification +### AutoModelForVisualQuestionAnswering -[[autodoc]] FlaxAutoModelForImageClassification +[[autodoc]] AutoModelForVisualQuestionAnswering + +### AutoModelForVision2Seq + +[[autodoc]] AutoModelForVision2Seq + +### TFAutoModelForVision2Seq + +[[autodoc]] TFAutoModelForVision2Seq -## FlaxAutoModelForVision2Seq +### FlaxAutoModelForVision2Seq [[autodoc]] FlaxAutoModelForVision2Seq From 97c1f613700596027a89fd8aaa96d64a26c0f3bf Mon Sep 17 00:00:00 2001 From: Steven Date: Mon, 5 Dec 2022 11:11:24 -0800 Subject: [PATCH 2/3] apply review --- docs/source/en/model_doc/auto.mdx | 44 ++++++++++++++++++------------- 1 file changed, 26 insertions(+), 18 deletions(-) diff --git a/docs/source/en/model_doc/auto.mdx b/docs/source/en/model_doc/auto.mdx index 60f50f6cc568..a59780ceec5d 100644 --- a/docs/source/en/model_doc/auto.mdx +++ b/docs/source/en/model_doc/auto.mdx @@ -74,33 +74,41 @@ Likewise, if your `NewModel` is a subclass of [`PreTrainedModel`], make sure its [[autodoc]] AutoProcessor -## AutoModel +## Generic model classes + +The following `AutoClasses` are available for instantiating a base model class without a specific head. + +### AutoModel [[autodoc]] AutoModel -## TFAutoModel +### TFAutoModel [[autodoc]] TFAutoModel -## FlaxAutoModel +### FlaxAutoModel [[autodoc]] FlaxAutoModel -## AutoModelForPreTraining +## Generic pretraining classes + +The following `AutoClasses` are available for instantiating a model with a pretraining head. + +### AutoModelForPreTraining [[autodoc]] AutoModelForPreTraining -## TFAutoModelForPreTraining +### TFAutoModelForPreTraining [[autodoc]] TFAutoModelForPreTraining -## FlaxAutoModelForPreTraining +### FlaxAutoModelForPreTraining [[autodoc]] FlaxAutoModelForPreTraining ## Natural Language Processing -[`AutoModel`], [`TFAutoModel`], and [`FlaxAutoModel`] are available for the following natural language processing tasks. +The following `AutoClasses` are available for the following natural language processing tasks. ### AutoModelForCausalLM @@ -198,17 +206,9 @@ Likewise, if your `NewModel` is a subclass of [`PreTrainedModel`], make sure its [[autodoc]] FlaxAutoModelForQuestionAnswering -### AutoModelForTableQuestionAnswering - -[[autodoc]] AutoModelForTableQuestionAnswering - -### TFAutoModelForTableQuestionAnswering - -[[autodoc]] TFAutoModelForTableQuestionAnswering - ## Computer vision -[`AutoModel`], [`TFAutoModel`], and [`FlaxAutoModel`] are available for the following computer vision tasks. +The following `AutoClasses` are available for the following computer vision tasks. ### AutoModelForDepthEstimation @@ -260,7 +260,7 @@ Likewise, if your `NewModel` is a subclass of [`PreTrainedModel`], make sure its ## Audio -[`AutoModel`] and [`TFAutoModel`] are available for the following audio tasks. +The following `AutoClasses` are available for the following audio tasks. ### AutoModelForAudioClassification @@ -288,7 +288,15 @@ Likewise, if your `NewModel` is a subclass of [`PreTrainedModel`], make sure its ## Multimodal -[`AutoModel`], [`TFAutoModel`], and [`FlaxAutoModel`] are available for the following multimodal tasks. +The following `AutoClasses` are available for the following multimodal tasks. + +### AutoModelForTableQuestionAnswering + +[[autodoc]] AutoModelForTableQuestionAnswering + +### TFAutoModelForTableQuestionAnswering + +[[autodoc]] TFAutoModelForTableQuestionAnswering ### AutoModelForDocumentQuestionAnswering From 51b200b4cf33be6a6f057709c7ec989e4280a6a2 Mon Sep 17 00:00:00 2001 From: Steven Date: Mon, 5 Dec 2022 12:06:02 -0800 Subject: [PATCH 3/3] auto classes --- docs/source/en/model_doc/auto.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/en/model_doc/auto.mdx b/docs/source/en/model_doc/auto.mdx index a59780ceec5d..7957f453a2fb 100644 --- a/docs/source/en/model_doc/auto.mdx +++ b/docs/source/en/model_doc/auto.mdx @@ -76,7 +76,7 @@ Likewise, if your `NewModel` is a subclass of [`PreTrainedModel`], make sure its ## Generic model classes -The following `AutoClasses` are available for instantiating a base model class without a specific head. +The following auto classes are available for instantiating a base model class without a specific head. ### AutoModel @@ -92,7 +92,7 @@ The following `AutoClasses` are available for instantiating a base model class w ## Generic pretraining classes -The following `AutoClasses` are available for instantiating a model with a pretraining head. +The following auto classes are available for instantiating a model with a pretraining head. ### AutoModelForPreTraining @@ -108,7 +108,7 @@ The following `AutoClasses` are available for instantiating a model with a pretr ## Natural Language Processing -The following `AutoClasses` are available for the following natural language processing tasks. +The following auto classes are available for the following natural language processing tasks. ### AutoModelForCausalLM @@ -208,7 +208,7 @@ The following `AutoClasses` are available for the following natural language pro ## Computer vision -The following `AutoClasses` are available for the following computer vision tasks. +The following auto classes are available for the following computer vision tasks. ### AutoModelForDepthEstimation @@ -260,7 +260,7 @@ The following `AutoClasses` are available for the following computer vision task ## Audio -The following `AutoClasses` are available for the following audio tasks. +The following auto classes are available for the following audio tasks. ### AutoModelForAudioClassification @@ -288,7 +288,7 @@ The following `AutoClasses` are available for the following audio tasks. ## Multimodal -The following `AutoClasses` are available for the following multimodal tasks. +The following auto classes are available for the following multimodal tasks. ### AutoModelForTableQuestionAnswering