diff --git a/docs/source/en/model_doc/albert.mdx b/docs/source/en/model_doc/albert.mdx index 8b33235121..1a8d6759c1 100644 --- a/docs/source/en/model_doc/albert.mdx +++ b/docs/source/en/model_doc/albert.mdx @@ -56,6 +56,14 @@ Next sentence prediction is replaced by a sentence ordering prediction: in the i This model was contributed by [lysandre](https://huggingface.co/lysandre). This model jax version was contributed by [kamalkraj](https://huggingface.co/kamalkraj). The original code can be found [here](https://github.com/google-research/ALBERT). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## AlbertConfig [[autodoc]] AlbertConfig diff --git a/docs/source/en/model_doc/audio-spectrogram-transformer.mdx b/docs/source/en/model_doc/audio-spectrogram-transformer.mdx index 54fbebc3b4..e1572697e0 100644 --- a/docs/source/en/model_doc/audio-spectrogram-transformer.mdx +++ b/docs/source/en/model_doc/audio-spectrogram-transformer.mdx @@ -47,6 +47,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - A notebook illustrating inference with AST for audio classification can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/AST). - [`ASTForAudioClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/audio-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/audio_classification.ipynb). +- See also: [Audio classification](./tasks/audio_classification). If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/bart.mdx b/docs/source/en/model_doc/bart.mdx index 8047082be2..bd9efdfd30 100644 --- a/docs/source/en/model_doc/bart.mdx +++ b/docs/source/en/model_doc/bart.mdx @@ -109,6 +109,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFBartForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/summarization) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/summarization-tf.ipynb). - [`FlaxBartForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/summarization). - [Summarization](https://huggingface.co/course/chapter7/5?fw=pt#summarization) chapter of the πŸ€— Hugging Face course. +- [Summarization task guide](./tasks/summarization) @@ -116,12 +117,19 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFBartForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling#run_mlmpy) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling-tf.ipynb). - [`FlaxBartForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/language-modeling#masked-language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/masked_language_modeling_flax.ipynb). - [Masked language modeling](https://huggingface.co/course/chapter7/3?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Masked language modeling task guide](./tasks/masked_language_modeling) - A notebook on how to [finetune mBART using Seq2SeqTrainer for Hindi to English translation](https://colab.research.google.com/github/vasudevgupta7/huggingface-tutorials/blob/main/translation_training.ipynb). 🌎 - [`BartForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/translation) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/translation.ipynb). - [`TFBartForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/translation) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/translation-tf.ipynb). +- [Translation task guide](./tasks/translation) + +See also: +- [Text classification task guide](./tasks/sequence_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) ## BartConfig diff --git a/docs/source/en/model_doc/beit.mdx b/docs/source/en/model_doc/beit.mdx index 17132ef0ed..ff423b3717 100644 --- a/docs/source/en/model_doc/beit.mdx +++ b/docs/source/en/model_doc/beit.mdx @@ -74,6 +74,10 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`BeitForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) + +**Semantic segmentation** +- [Semantic segmentation task guide](./tasks/semantic_segmentation) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/bert.mdx b/docs/source/en/model_doc/bert.mdx index e6c47a9aa9..d3b3ff217b 100644 --- a/docs/source/en/model_doc/bert.mdx +++ b/docs/source/en/model_doc/bert.mdx @@ -72,6 +72,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`BertForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification.ipynb). - [`TFBertForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification-tf.ipynb). - [`FlaxBertForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification_flax.ipynb). +- [Text classification task guide](./tasks/sequence_classification) @@ -81,6 +82,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFBertForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/token-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/token_classification-tf.ipynb). - [`FlaxBertForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/token-classification). - [Token classification](https://huggingface.co/course/chapter7/2?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Token classification task guide](./tasks/token_classification) @@ -88,6 +90,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFBertForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling#run_mlmpy) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling-tf.ipynb). - [`FlaxBertForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/language-modeling#masked-language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/masked_language_modeling_flax.ipynb). - [Masked language modeling](https://huggingface.co/course/chapter7/3?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Masked language modeling task guide](./tasks/masked_language_modeling) @@ -95,10 +98,12 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFBertForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/question-answering) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/question_answering-tf.ipynb). - [`FlaxBertForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/question-answering). - [Question answering](https://huggingface.co/course/chapter7/7?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Question answering task guide](./tasks/question_answering) **Multiple choice** - [`BertForMultipleChoice`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/multiple-choice) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/multiple_choice.ipynb). - [`TFBertForMultipleChoice`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/multiple-choice) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/multiple_choice-tf.ipynb). +- [Multiple choice task guide](./tasks/multiple_choice) ⚑️ **Inference** - A blog post on how to [Accelerate BERT inference with Hugging Face Transformers and AWS Inferentia](https://huggingface.co/blog/bert-inferentia-sagemaker). diff --git a/docs/source/en/model_doc/big_bird.mdx b/docs/source/en/model_doc/big_bird.mdx index fa15d32cdb..b0511aeb6c 100644 --- a/docs/source/en/model_doc/big_bird.mdx +++ b/docs/source/en/model_doc/big_bird.mdx @@ -52,6 +52,15 @@ Tips: This model was contributed by [vasudevgupta](https://huggingface.co/vasudevgupta). The original code can be found [here](https://github.com/google-research/bigbird). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## BigBirdConfig [[autodoc]] BigBirdConfig diff --git a/docs/source/en/model_doc/bigbird_pegasus.mdx b/docs/source/en/model_doc/bigbird_pegasus.mdx index 1ba4b71d73..23e741f4ea 100644 --- a/docs/source/en/model_doc/bigbird_pegasus.mdx +++ b/docs/source/en/model_doc/bigbird_pegasus.mdx @@ -52,6 +52,14 @@ Tips: The original code can be found [here](https://github.com/google-research/bigbird). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) + ## BigBirdPegasusConfig [[autodoc]] BigBirdPegasusConfig diff --git a/docs/source/en/model_doc/biogpt.mdx b/docs/source/en/model_doc/biogpt.mdx index 84bd96d768..a2a17ad32d 100644 --- a/docs/source/en/model_doc/biogpt.mdx +++ b/docs/source/en/model_doc/biogpt.mdx @@ -29,6 +29,10 @@ Tips: This model was contributed by [kamalkraj](https://huggingface.co/kamalkraj). The original code can be found [here](https://github.com/microsoft/BioGPT). +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) + ## BioGptConfig [[autodoc]] BioGptConfig diff --git a/docs/source/en/model_doc/bit.mdx b/docs/source/en/model_doc/bit.mdx index a9b3ff33b7..2f0cba77f5 100644 --- a/docs/source/en/model_doc/bit.mdx +++ b/docs/source/en/model_doc/bit.mdx @@ -37,6 +37,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`BitForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/blenderbot-small.mdx b/docs/source/en/model_doc/blenderbot-small.mdx index c4b157cac1..c756346fea 100644 --- a/docs/source/en/model_doc/blenderbot-small.mdx +++ b/docs/source/en/model_doc/blenderbot-small.mdx @@ -42,7 +42,13 @@ Tips: the left. This model was contributed by [patrickvonplaten](https://huggingface.co/patrickvonplaten). The authors' code can be -found [here](https://github.com/facebookresearch/ParlAI) . +found [here](https://github.com/facebookresearch/ParlAI). + +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) ## BlenderbotSmallConfig diff --git a/docs/source/en/model_doc/blenderbot.mdx b/docs/source/en/model_doc/blenderbot.mdx index 75706e13ec..00de4288d2 100644 --- a/docs/source/en/model_doc/blenderbot.mdx +++ b/docs/source/en/model_doc/blenderbot.mdx @@ -66,6 +66,12 @@ Here is an example of model usage: [" That's unfortunate. Are they trying to lose weight or are they just trying to be healthier?"] ``` +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) + ## BlenderbotConfig [[autodoc]] BlenderbotConfig diff --git a/docs/source/en/model_doc/bloom.mdx b/docs/source/en/model_doc/bloom.mdx index a3a2aa81d7..fd3df58e43 100644 --- a/docs/source/en/model_doc/bloom.mdx +++ b/docs/source/en/model_doc/bloom.mdx @@ -27,13 +27,19 @@ Several smaller versions of the models have been trained on the same dataset. BL ## Resources - A list of official Hugging Face and community (indicated by 🌎) resources to help you get started with BLOOM. If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. - [`BloomForCausalLM`] is supported by this [causal language modeling example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/language-modeling#gpt-2gpt-and-causal-language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling.ipynb). +See also: +- [Causal language modeling task guide](./tasks/language_modeling) +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) + + ⚑️ Inference - A blog on [Optimization story: Bloom inference](https://huggingface.co/blog/bloom-inference-optimization). - A blog on [Incredibly Fast BLOOM Inference with DeepSpeed and Accelerate](https://huggingface.co/blog/bloom-inference-pytorch-scripts). diff --git a/docs/source/en/model_doc/camembert.mdx b/docs/source/en/model_doc/camembert.mdx index a35d5aefca..78a2b8a585 100644 --- a/docs/source/en/model_doc/camembert.mdx +++ b/docs/source/en/model_doc/camembert.mdx @@ -37,6 +37,15 @@ Tips: This model was contributed by [camembert](https://huggingface.co/camembert). The original code can be found [here](https://camembert-model.fr/). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## CamembertConfig [[autodoc]] CamembertConfig diff --git a/docs/source/en/model_doc/canine.mdx b/docs/source/en/model_doc/canine.mdx index e73777d000..175f7c304e 100644 --- a/docs/source/en/model_doc/canine.mdx +++ b/docs/source/en/model_doc/canine.mdx @@ -92,6 +92,13 @@ sequences to the same length): >>> sequence_output = outputs.last_hidden_state ``` +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Multiple choice task guide](./tasks/multiple_choice) + ## CANINE specific outputs [[autodoc]] models.canine.modeling_canine.CanineModelOutputWithPooling diff --git a/docs/source/en/model_doc/codegen.mdx b/docs/source/en/model_doc/codegen.mdx index c46649e001..f36aec36a5 100644 --- a/docs/source/en/model_doc/codegen.mdx +++ b/docs/source/en/model_doc/codegen.mdx @@ -56,6 +56,10 @@ def hello_world(): hello_world() ``` +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) + ## CodeGenConfig [[autodoc]] CodeGenConfig diff --git a/docs/source/en/model_doc/conditional_detr.mdx b/docs/source/en/model_doc/conditional_detr.mdx index 40cdbee345..4d51aa4cda 100644 --- a/docs/source/en/model_doc/conditional_detr.mdx +++ b/docs/source/en/model_doc/conditional_detr.mdx @@ -27,6 +27,9 @@ alt="drawing" width="600"/> This model was contributed by [DepuMeng](https://huggingface.co/DepuMeng). The original code can be found [here](https://github.com/Atten4Vis/ConditionalDETR). +## Documentation resources + +- [Object detection task guide](./tasks/object_detection) ## ConditionalDetrConfig diff --git a/docs/source/en/model_doc/convbert.mdx b/docs/source/en/model_doc/convbert.mdx index a1dba6bf1c..dbb0c3d420 100644 --- a/docs/source/en/model_doc/convbert.mdx +++ b/docs/source/en/model_doc/convbert.mdx @@ -45,6 +45,14 @@ ConvBERT training tips are similar to those of BERT. This model was contributed by [abhishek](https://huggingface.co/abhishek). The original implementation can be found here: https://github.com/yitu-opensource/ConvBert +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## ConvBertConfig [[autodoc]] ConvBertConfig diff --git a/docs/source/en/model_doc/convnext.mdx b/docs/source/en/model_doc/convnext.mdx index 857a2adeb2..389d017992 100644 --- a/docs/source/en/model_doc/convnext.mdx +++ b/docs/source/en/model_doc/convnext.mdx @@ -47,6 +47,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`ConvNextForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/ctrl.mdx b/docs/source/en/model_doc/ctrl.mdx index aedfd04764..54f21b6e42 100644 --- a/docs/source/en/model_doc/ctrl.mdx +++ b/docs/source/en/model_doc/ctrl.mdx @@ -55,6 +55,10 @@ Tips: This model was contributed by [keskarnitishr](https://huggingface.co/keskarnitishr). The original code can be found [here](https://github.com/salesforce/ctrl). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Causal language modeling task guide](./tasks/language_modeling) ## CTRLConfig diff --git a/docs/source/en/model_doc/cvt.mdx b/docs/source/en/model_doc/cvt.mdx index 9d0fa7ea88..3b9fa2c365 100644 --- a/docs/source/en/model_doc/cvt.mdx +++ b/docs/source/en/model_doc/cvt.mdx @@ -45,6 +45,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`CvtForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/data2vec.mdx b/docs/source/en/model_doc/data2vec.mdx index 39be094542..c9df6d2d5e 100644 --- a/docs/source/en/model_doc/data2vec.mdx +++ b/docs/source/en/model_doc/data2vec.mdx @@ -54,6 +54,22 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`Data2VecVisionForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). - To fine-tune [`TFData2VecVisionForImageClassification`] on a custom dataset, see [this notebook](https://colab.research.google.com/github/sayakpaul/TF-2.0-Hacks/blob/master/data2vec_vision_image_classification.ipynb). +**Data2VecText documentation resources** +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + +**Data2VecAudio documentation resources** +- [Audio classification task guide](./tasks/audio_classification) +- [Automatic speech recognition task guide](./tasks/asr) + +**Data2VecVision documentation resources** +- [Image classification](./tasks/image_classification) +- [Semantic segmentation](./tasks/semantic_segmentation) + If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. ## Data2VecTextConfig diff --git a/docs/source/en/model_doc/deberta-v2.mdx b/docs/source/en/model_doc/deberta-v2.mdx index 18b2c4f16d..63129a1ef7 100644 --- a/docs/source/en/model_doc/deberta-v2.mdx +++ b/docs/source/en/model_doc/deberta-v2.mdx @@ -58,6 +58,13 @@ New in v2: This model was contributed by [DeBERTa](https://huggingface.co/DeBERTa). This model TF 2.0 implementation was contributed by [kamalkraj](https://huggingface.co/kamalkraj). The original code can be found [here](https://github.com/microsoft/DeBERTa). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## DebertaV2Config diff --git a/docs/source/en/model_doc/deberta.mdx b/docs/source/en/model_doc/deberta.mdx index 33b1ec6a51..ec68ed03ae 100644 --- a/docs/source/en/model_doc/deberta.mdx +++ b/docs/source/en/model_doc/deberta.mdx @@ -48,6 +48,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - A blog post on [Supercharged Customer Service with Machine Learning](https://huggingface.co/blog/supercharge-customer-service-with-machine-learning) with DeBERTa. - [`DebertaForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification.ipynb). - [`TFDebertaForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification-tf.ipynb). +- [Text classification task guide](./tasks/sequence_classification) @@ -55,18 +56,21 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFDebertaForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/token-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/token_classification-tf.ipynb). - [Token classification](https://huggingface.co/course/chapter7/2?fw=pt) chapter of the πŸ€— Hugging Face Course. - [Byte-Pair Encoding tokenization](https://huggingface.co/course/chapter6/5?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Token classification task guide](./tasks/token_classification) - [`DebertaForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/language-modeling#robertabertdistilbert-and-masked-language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling.ipynb). - [`TFDebertaForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling#run_mlmpy) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling-tf.ipynb). - [Masked language modeling](https://huggingface.co/course/chapter7/3?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Masked language modeling task guide](./tasks/masked_language_modeling) - [`DebertaForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/question-answering) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/question_answering.ipynb). - [`TFDebertaForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/question-answering) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/question_answering-tf.ipynb). - [Question answering](https://huggingface.co/course/chapter7/7?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Question answering task guide](./tasks/question_answering) ## DebertaConfig diff --git a/docs/source/en/model_doc/deformable_detr.mdx b/docs/source/en/model_doc/deformable_detr.mdx index 32cb68746d..f9b763c7ba 100644 --- a/docs/source/en/model_doc/deformable_detr.mdx +++ b/docs/source/en/model_doc/deformable_detr.mdx @@ -40,6 +40,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - Demo notebooks regarding inference + fine-tuning on a custom dataset for [`DeformableDetrForObjectDetection`] can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/Deformable-DETR). +- See also: [Object detection task guide](./tasks/object_detection). If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/deit.mdx b/docs/source/en/model_doc/deit.mdx index 0640a13391..4e38b1e2ad 100644 --- a/docs/source/en/model_doc/deit.mdx +++ b/docs/source/en/model_doc/deit.mdx @@ -78,6 +78,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`DeiTForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) Besides that: diff --git a/docs/source/en/model_doc/deta.mdx b/docs/source/en/model_doc/deta.mdx index 61b705d42b..d9a411d2eb 100644 --- a/docs/source/en/model_doc/deta.mdx +++ b/docs/source/en/model_doc/deta.mdx @@ -39,6 +39,7 @@ The original code can be found [here](https://github.com/jozhang97/DETA). A list of official Hugging Face and community (indicated by 🌎) resources to help you get started with DETA. - Demo notebooks for DETA can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/DETA). +- See also: [Object detection task guide](./tasks/object_detection) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/detr.mdx b/docs/source/en/model_doc/detr.mdx index 872a7d4387..2467a085fc 100644 --- a/docs/source/en/model_doc/detr.mdx +++ b/docs/source/en/model_doc/detr.mdx @@ -157,6 +157,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - All example notebooks illustrating fine-tuning [`DetrForObjectDetection`] and [`DetrForSegmentation`] on a custom dataset an be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/DETR). +- See also: [Object detection task guide](./tasks/object_detection) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/dinat.mdx b/docs/source/en/model_doc/dinat.mdx index 1f6577e21a..bb56d22627 100644 --- a/docs/source/en/model_doc/dinat.mdx +++ b/docs/source/en/model_doc/dinat.mdx @@ -68,6 +68,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`DinatForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/distilbert.mdx b/docs/source/en/model_doc/distilbert.mdx index 99e65522f2..43b329952c 100644 --- a/docs/source/en/model_doc/distilbert.mdx +++ b/docs/source/en/model_doc/distilbert.mdx @@ -75,6 +75,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`DistilBertForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification.ipynb). - [`TFDistilBertForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification-tf.ipynb). - [`FlaxDistilBertForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification_flax.ipynb). +- [Text classification task guide](./tasks/sequence_classification) @@ -83,6 +84,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFDistilBertForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/token-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/token_classification-tf.ipynb). - [`FlaxDistilBertForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/token-classification). - [Token classification](https://huggingface.co/course/chapter7/2?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Token classification task guide](./tasks/token_classification) @@ -91,6 +93,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFDistilBertForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling#run_mlmpy) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling-tf.ipynb). - [`FlaxDistilBertForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/language-modeling#masked-language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/masked_language_modeling_flax.ipynb). - [Masked language modeling](https://huggingface.co/course/chapter7/3?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Masked language modeling task guide](./tasks/masked_language_modeling) @@ -98,10 +101,12 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFDistilBertForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/question-answering) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/question_answering-tf.ipynb). - [`FlaxDistilBertForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/question-answering). - [Question answering](https://huggingface.co/course/chapter7/7?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Question answering task guide](./tasks/question_answering) **Multiple choice** - [`DistilBertForMultipleChoice`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/multiple-choice) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/multiple_choice.ipynb). - [`TFDistilBertForMultipleChoice`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/multiple-choice) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/multiple_choice-tf.ipynb). +- [Multiple choice task guide](./tasks/multiple_choice) βš—οΈ Optimization diff --git a/docs/source/en/model_doc/dpt.mdx b/docs/source/en/model_doc/dpt.mdx index 705dc680e6..b19a7468e6 100644 --- a/docs/source/en/model_doc/dpt.mdx +++ b/docs/source/en/model_doc/dpt.mdx @@ -33,6 +33,7 @@ This model was contributed by [nielsr](https://huggingface.co/nielsr). The origi A list of official Hugging Face and community (indicated by 🌎) resources to help you get started with DPT. - Demo notebooks for [`DPTForDepthEstimation`] can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/DPT). +- See also: [Semantic segmentation task guide](./tasks/semantic_segmentation) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/efficientformer.mdx b/docs/source/en/model_doc/efficientformer.mdx index aba86f1317..e4b1b00701 100644 --- a/docs/source/en/model_doc/efficientformer.mdx +++ b/docs/source/en/model_doc/efficientformer.mdx @@ -39,6 +39,9 @@ reach extremely low latency on mobile devices while maintaining high performance This model was contributed by [novice03](https://huggingface.co/novice03) and [Bearnardd](https://huggingface.co/Bearnardd). The original code can be found [here](https://github.com/snap-research/EfficientFormer). +## Documentation resources + +- [Image classification task guide](./tasks/image_classification) ## EfficientFormerConfig diff --git a/docs/source/en/model_doc/electra.mdx b/docs/source/en/model_doc/electra.mdx index 80074a7b0b..ce1c55487f 100644 --- a/docs/source/en/model_doc/electra.mdx +++ b/docs/source/en/model_doc/electra.mdx @@ -64,6 +64,14 @@ Tips: This model was contributed by [lysandre](https://huggingface.co/lysandre). The original code can be found [here](https://github.com/google-research/electra). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## ElectraConfig diff --git a/docs/source/en/model_doc/ernie.mdx b/docs/source/en/model_doc/ernie.mdx index 6ec3f10473..17869e2921 100644 --- a/docs/source/en/model_doc/ernie.mdx +++ b/docs/source/en/model_doc/ernie.mdx @@ -47,6 +47,15 @@ You can find all the supported models from huggingface's model hub: [huggingface repo: [PaddleNLP](https://paddlenlp.readthedocs.io/zh/latest/model_zoo/transformers/ERNIE/contents.html) and [ERNIE](https://github.com/PaddlePaddle/ERNIE/blob/repro). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## ErnieConfig [[autodoc]] ErnieConfig diff --git a/docs/source/en/model_doc/ernie_m.mdx b/docs/source/en/model_doc/ernie_m.mdx index 3164747367..8861647e89 100644 --- a/docs/source/en/model_doc/ernie_m.mdx +++ b/docs/source/en/model_doc/ernie_m.mdx @@ -32,6 +32,13 @@ Tips: This model was contributed by [Susnato Dhar](https://huggingface.co/susnato). The original code can be found [here](https://github.com/PaddlePaddle/PaddleNLP/tree/develop/paddlenlp/transformers/ernie_m). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Multiple choice task guide](./tasks/multiple_choice) + ## ErnieMConfig [[autodoc]] ErnieMConfig diff --git a/docs/source/en/model_doc/esm.mdx b/docs/source/en/model_doc/esm.mdx index 9462e9db08..90e18ce45e 100644 --- a/docs/source/en/model_doc/esm.mdx +++ b/docs/source/en/model_doc/esm.mdx @@ -86,6 +86,12 @@ help throughout the process! The HuggingFace port of ESMFold uses portions of the [openfold](https://github.com/aqlaboratory/openfold) library. The `openfold` library is licensed under the Apache License 2.0. +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Masked language modeling task guide](./tasks/masked_language_modeling) + ## EsmConfig [[autodoc]] EsmConfig diff --git a/docs/source/en/model_doc/flaubert.mdx b/docs/source/en/model_doc/flaubert.mdx index fe8ef3e050..443916ee07 100644 --- a/docs/source/en/model_doc/flaubert.mdx +++ b/docs/source/en/model_doc/flaubert.mdx @@ -46,7 +46,13 @@ This model was contributed by [formiel](https://huggingface.co/formiel). The ori Tips: - Like RoBERTa, without the sentence ordering prediction (so just trained on the MLM objective). +## Documentation resources +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## FlaubertConfig diff --git a/docs/source/en/model_doc/fnet.mdx b/docs/source/en/model_doc/fnet.mdx index 19afcc8051..140e61d4c4 100644 --- a/docs/source/en/model_doc/fnet.mdx +++ b/docs/source/en/model_doc/fnet.mdx @@ -41,6 +41,14 @@ Tips on usage: This model was contributed by [gchhablani](https://huggingface.co/gchhablani). The original code can be found [here](https://github.com/google-research/google-research/tree/master/f_net). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## FNetConfig [[autodoc]] FNetConfig diff --git a/docs/source/en/model_doc/funnel.mdx b/docs/source/en/model_doc/funnel.mdx index 055cf6257b..1edba7d737 100644 --- a/docs/source/en/model_doc/funnel.mdx +++ b/docs/source/en/model_doc/funnel.mdx @@ -60,6 +60,14 @@ Tips: This model was contributed by [sgugger](https://huggingface.co/sgugger). The original code can be found [here](https://github.com/laiguokun/Funnel-Transformer). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## FunnelConfig diff --git a/docs/source/en/model_doc/git.mdx b/docs/source/en/model_doc/git.mdx index 543548d8e6..0918e7c36c 100644 --- a/docs/source/en/model_doc/git.mdx +++ b/docs/source/en/model_doc/git.mdx @@ -41,6 +41,7 @@ The original code can be found [here](https://github.com/microsoft/GenerativeIma A list of official Hugging Face and community (indicated by 🌎) resources to help you get started with GIT. - Demo notebooks regarding inference + fine-tuning GIT on custom data can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/GIT). +- See also: [Causal language modeling task guide](./tasks/language_modeling) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we will review it. The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/gpt-sw3.mdx b/docs/source/en/model_doc/gpt-sw3.mdx index 23b6dc976d..0ee4a43f4c 100644 --- a/docs/source/en/model_doc/gpt-sw3.mdx +++ b/docs/source/en/model_doc/gpt-sw3.mdx @@ -48,6 +48,12 @@ Example usage: TrΓ€d Γ€r fina fΓΆr att de Γ€r fΓ€rgstarka. Men ibland Γ€r det fint ``` +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Causal language modeling task guide](./tasks/language_modeling) + ## GPTSw3Tokenizer [[autodoc]] GPTSw3Tokenizer diff --git a/docs/source/en/model_doc/gpt2.mdx b/docs/source/en/model_doc/gpt2.mdx index 7e557d0e9d..d605a1449d 100644 --- a/docs/source/en/model_doc/gpt2.mdx +++ b/docs/source/en/model_doc/gpt2.mdx @@ -73,7 +73,9 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`GPT2LMHeadModel`] is supported by this [causal language modeling example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/language-modeling#gpt-2gpt-and-causal-language-modeling), [text generation example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/text-generation), and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling.ipynb). - [`TFGPT2LMHeadModel`] is supported by this [causal language modeling example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling#run_clmpy) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling-tf.ipynb). - [`FlaxGPT2LMHeadModel`] is supported by this [causal language modeling example script](https://github.com/huggingface/transformers/tree/main/examples/flax/language-modeling#causal-language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/causal_language_modeling_flax.ipynb). - +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Causal language modeling task guide](./tasks/language_modeling) ## GPT2Config diff --git a/docs/source/en/model_doc/gpt_neo.mdx b/docs/source/en/model_doc/gpt_neo.mdx index f68b92b213..af55c88a26 100644 --- a/docs/source/en/model_doc/gpt_neo.mdx +++ b/docs/source/en/model_doc/gpt_neo.mdx @@ -50,6 +50,11 @@ The `generate()` method can be used to generate text using GPT Neo model. >>> gen_text = tokenizer.batch_decode(gen_tokens)[0] ``` +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Causal language modeling task guide](./tasks/language_modeling) + ## GPTNeoConfig [[autodoc]] GPTNeoConfig diff --git a/docs/source/en/model_doc/gpt_neox.mdx b/docs/source/en/model_doc/gpt_neox.mdx index 1be8be7a6a..cd85f03e73 100644 --- a/docs/source/en/model_doc/gpt_neox.mdx +++ b/docs/source/en/model_doc/gpt_neox.mdx @@ -57,6 +57,10 @@ The `generate()` method can be used to generate text using GPT Neo model. >>> gen_text = tokenizer.batch_decode(gen_tokens)[0] ``` +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) + ## GPTNeoXConfig [[autodoc]] GPTNeoXConfig diff --git a/docs/source/en/model_doc/gpt_neox_japanese.mdx b/docs/source/en/model_doc/gpt_neox_japanese.mdx index da94b74976..bc0c259f74 100644 --- a/docs/source/en/model_doc/gpt_neox_japanese.mdx +++ b/docs/source/en/model_doc/gpt_neox_japanese.mdx @@ -47,6 +47,10 @@ The `generate()` method can be used to generate text using GPT NeoX Japanese mod 人とAIγŒε”θͺΏγ™γ‚‹γŸγ‚γ«γ―、AIγ¨δΊΊγŒε…±ε­˜γ—γ€AIγ‚’ζ­£γ—γη†θ§£γ™γ‚‹εΏ…θ¦γŒγ‚γ‚ŠγΎγ™γ€‚ ``` +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) + ## GPTNeoXJapaneseConfig [[autodoc]] GPTNeoXJapaneseConfig diff --git a/docs/source/en/model_doc/gptj.mdx b/docs/source/en/model_doc/gptj.mdx index 51cee1d72a..98247fcfb0 100644 --- a/docs/source/en/model_doc/gptj.mdx +++ b/docs/source/en/model_doc/gptj.mdx @@ -122,6 +122,11 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFGPTJForCausalLM`] is supported by this [causal language modeling example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling#run_clmpy) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling-tf.ipynb). - [`FlaxGPTJForCausalLM`] is supported by this [causal language modeling example script](https://github.com/huggingface/transformers/tree/main/examples/flax/language-modeling#causal-language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/causal_language_modeling_flax.ipynb). +**Documentation resources** +- [Text classification task guide](./tasks/sequence_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) + ## GPTJConfig [[autodoc]] GPTJConfig diff --git a/docs/source/en/model_doc/hubert.mdx b/docs/source/en/model_doc/hubert.mdx index faab44b89d..55935e1a5c 100644 --- a/docs/source/en/model_doc/hubert.mdx +++ b/docs/source/en/model_doc/hubert.mdx @@ -40,6 +40,10 @@ Tips: This model was contributed by [patrickvonplaten](https://huggingface.co/patrickvonplaten). +## Documentation resources + +- [Audio classification task guide](./tasks/audio_classification) +- [Automatic speech recognition task guide](./tasks/asr) ## HubertConfig diff --git a/docs/source/en/model_doc/ibert.mdx b/docs/source/en/model_doc/ibert.mdx index 086e615fe5..f665374781 100644 --- a/docs/source/en/model_doc/ibert.mdx +++ b/docs/source/en/model_doc/ibert.mdx @@ -36,6 +36,13 @@ been open-sourced.* This model was contributed by [kssteven](https://huggingface.co/kssteven). The original code can be found [here](https://github.com/kssteven418/I-BERT). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/masked_language_modeling) ## IBertConfig diff --git a/docs/source/en/model_doc/imagegpt.mdx b/docs/source/en/model_doc/imagegpt.mdx index baee48b96e..1c26592236 100644 --- a/docs/source/en/model_doc/imagegpt.mdx +++ b/docs/source/en/model_doc/imagegpt.mdx @@ -77,6 +77,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - Demo notebooks for ImageGPT can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/ImageGPT). - [`ImageGPTForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/layoutlm.mdx b/docs/source/en/model_doc/layoutlm.mdx index 57475abb63..c33f59c3bd 100644 --- a/docs/source/en/model_doc/layoutlm.mdx +++ b/docs/source/en/model_doc/layoutlm.mdx @@ -88,13 +88,20 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - A notebook on how to [fine-tune LayoutLM on the FUNSD dataset with image embeddings](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLM/Add_image_embeddings_to_LayoutLM.ipynb). +- See also: [Document question answering task guide](./tasks/document_question_answering) + - A notebook on how to [fine-tune LayoutLM for sequence classification on the RVL-CDIP dataset](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLM/Fine_tuning_LayoutLMForSequenceClassification_on_RVL_CDIP.ipynb). +- [Text classification task guide](./tasks/sequence_classification) - A notebook on how to [ fine-tune LayoutLM for token classification on the FUNSD dataset](https://github.com/NielsRogge/Transformers-Tutorials/blob/master/LayoutLM/Fine_tuning_LayoutLMForTokenClassification_on_FUNSD.ipynb). +- [Token classification task guide](./tasks/token_classification) + +**Other resources** +- [Masked language modeling task guide](./tasks/masked_language_modeling) πŸš€ Deploy diff --git a/docs/source/en/model_doc/layoutlmv2.mdx b/docs/source/en/model_doc/layoutlmv2.mdx index dc225d768d..af29db0574 100644 --- a/docs/source/en/model_doc/layoutlmv2.mdx +++ b/docs/source/en/model_doc/layoutlmv2.mdx @@ -266,6 +266,13 @@ print(encoding.keys()) # dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'bbox', 'image']) ``` +## Documentation resources + +- [Document question answering task guide](./tasks/document_question_answering) +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) + ## LayoutLMv2Config [[autodoc]] LayoutLMv2Config diff --git a/docs/source/en/model_doc/layoutlmv3.mdx b/docs/source/en/model_doc/layoutlmv3.mdx index d49ee1819a..5145452dd8 100644 --- a/docs/source/en/model_doc/layoutlmv3.mdx +++ b/docs/source/en/model_doc/layoutlmv3.mdx @@ -52,17 +52,22 @@ LayoutLMv3 is nearly identical to LayoutLMv2, so we've also included LayoutLMv2 - [`LayoutLMv2ForSequenceClassification`] is supported by this [notebook](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv2/RVL-CDIP/Fine_tuning_LayoutLMv2ForSequenceClassification_on_RVL_CDIP.ipynb). +- [Text classification task guide](./tasks/sequence_classification) - [`LayoutLMv3ForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/research_projects/layoutlmv3) and [notebook](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv3/Fine_tune_LayoutLMv3_on_FUNSD_(HuggingFace_Trainer).ipynb). - A [notebook](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv2/FUNSD/Inference_with_LayoutLMv2ForTokenClassification.ipynb) for how to perform inference with [`LayoutLMv2ForTokenClassification`] and a [notebook](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv2/FUNSD/True_inference_with_LayoutLMv2ForTokenClassification_%2B_Gradio_demo.ipynb) for how to perform inference when no labels are available with [`LayoutLMv2ForTokenClassification`]. - A [notebook](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv2/FUNSD/Fine_tuning_LayoutLMv2ForTokenClassification_on_FUNSD_using_HuggingFace_Trainer.ipynb) for how to finetune [`LayoutLMv2ForTokenClassification`] with the πŸ€— Trainer. +- [Token classification task guide](./tasks/token_classification) - [`LayoutLMv2ForQuestionAnswering`] is supported by this [notebook](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv2/DocVQA/Fine_tuning_LayoutLMv2ForQuestionAnswering_on_DocVQA.ipynb). +- [Question answering task guide](./tasks/question_answering) +**Document question answering** +- [Document question answering task guide](./tasks/document_question_answering) ## LayoutLMv3Config diff --git a/docs/source/en/model_doc/led.mdx b/docs/source/en/model_doc/led.mdx index 6ecdf808e2..a8916f6833 100644 --- a/docs/source/en/model_doc/led.mdx +++ b/docs/source/en/model_doc/led.mdx @@ -55,6 +55,12 @@ Tips: This model was contributed by [patrickvonplaten](https://huggingface.co/patrickvonplaten). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Question answering task guide](./tasks/question_answering) +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) ## LEDConfig diff --git a/docs/source/en/model_doc/levit.mdx b/docs/source/en/model_doc/levit.mdx index 69c2e00c0b..975c67a237 100644 --- a/docs/source/en/model_doc/levit.mdx +++ b/docs/source/en/model_doc/levit.mdx @@ -68,6 +68,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`LevitForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/lilt.mdx b/docs/source/en/model_doc/lilt.mdx index f29a8d67a3..f238e6b3e9 100644 --- a/docs/source/en/model_doc/lilt.mdx +++ b/docs/source/en/model_doc/lilt.mdx @@ -52,6 +52,11 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - Demo notebooks for LiLT can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/LiLT). +**Documentation resources** +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) + If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. ## LiltConfig diff --git a/docs/source/en/model_doc/longformer.mdx b/docs/source/en/model_doc/longformer.mdx index 7c8f2c6991..d725b96fe1 100644 --- a/docs/source/en/model_doc/longformer.mdx +++ b/docs/source/en/model_doc/longformer.mdx @@ -89,6 +89,14 @@ mlm_labels = tokenizer.encode("This is a sentence from the training data", retur loss = model(input_ids, labels=input_ids, masked_lm_labels=mlm_labels)[0] ``` +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## LongformerConfig [[autodoc]] LongformerConfig diff --git a/docs/source/en/model_doc/longt5.mdx b/docs/source/en/model_doc/longt5.mdx index 0e73d6c8dd..ae771f4448 100644 --- a/docs/source/en/model_doc/longt5.mdx +++ b/docs/source/en/model_doc/longt5.mdx @@ -86,6 +86,10 @@ The complexity of this mechanism is `O(l(r + l/k))`. This model was contributed by [stancld](https://huggingface.co/stancld). The original code can be found [here](https://github.com/google-research/longt5). +## Documentation resources + +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) ## LongT5Config diff --git a/docs/source/en/model_doc/luke.mdx b/docs/source/en/model_doc/luke.mdx index b7483f9194..98e5501399 100644 --- a/docs/source/en/model_doc/luke.mdx +++ b/docs/source/en/model_doc/luke.mdx @@ -117,6 +117,13 @@ Example: This model was contributed by [ikuyamada](https://huggingface.co/ikuyamada) and [nielsr](https://huggingface.co/nielsr). The original code can be found [here](https://github.com/studio-ousia/luke). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## LukeConfig diff --git a/docs/source/en/model_doc/lxmert.mdx b/docs/source/en/model_doc/lxmert.mdx index 51a5be07d7..6941dd99bb 100644 --- a/docs/source/en/model_doc/lxmert.mdx +++ b/docs/source/en/model_doc/lxmert.mdx @@ -51,6 +51,9 @@ Tips: This model was contributed by [eltoto1219](https://huggingface.co/eltoto1219). The original code can be found [here](https://github.com/airsplay/lxmert). +## Documentation resources + +- [Question answering task guide](./tasks/question_answering) ## LxmertConfig diff --git a/docs/source/en/model_doc/m2m_100.mdx b/docs/source/en/model_doc/m2m_100.mdx index 10ac6a9df9..2d62a556c0 100644 --- a/docs/source/en/model_doc/m2m_100.mdx +++ b/docs/source/en/model_doc/m2m_100.mdx @@ -91,6 +91,11 @@ loss = model(**model_inputs).loss # forward pass "Life is like a box of chocolate." ``` +## Documentation resources + +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) + ## M2M100Config [[autodoc]] M2M100Config diff --git a/docs/source/en/model_doc/marian.mdx b/docs/source/en/model_doc/marian.mdx index 07240ccbc7..9192aa9080 100644 --- a/docs/source/en/model_doc/marian.mdx +++ b/docs/source/en/model_doc/marian.mdx @@ -161,6 +161,12 @@ Example of translating english to many romance languages, using old-style 2 char 'Y esto al espaΓ±ol'] ``` +## Documentation resources + +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) +- [Causal language modeling task guide](./tasks/language_modeling) + ## MarianConfig [[autodoc]] MarianConfig diff --git a/docs/source/en/model_doc/markuplm.mdx b/docs/source/en/model_doc/markuplm.mdx index f4deb6d873..ea381a370c 100644 --- a/docs/source/en/model_doc/markuplm.mdx +++ b/docs/source/en/model_doc/markuplm.mdx @@ -193,6 +193,12 @@ all nodes and xpaths yourself, you can provide them directly to the processor. M dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'xpath_tags_seq', 'xpath_subs_seq']) ``` +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) + ## MarkupLMConfig [[autodoc]] MarkupLMConfig diff --git a/docs/source/en/model_doc/mbart.mdx b/docs/source/en/model_doc/mbart.mdx index 26835baf73..773b52a436 100644 --- a/docs/source/en/model_doc/mbart.mdx +++ b/docs/source/en/model_doc/mbart.mdx @@ -152,6 +152,15 @@ tokenizer.batch_decode(generated_tokens, skip_special_tokens=True) # => "The Secretary-General of the United Nations says there is no military solution in Syria." ``` +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) + ## MBartConfig [[autodoc]] MBartConfig diff --git a/docs/source/en/model_doc/mctct.mdx b/docs/source/en/model_doc/mctct.mdx index 690714ded6..46f07c763f 100644 --- a/docs/source/en/model_doc/mctct.mdx +++ b/docs/source/en/model_doc/mctct.mdx @@ -31,6 +31,9 @@ performance for many languages that also transfers well to LibriSpeech.* This model was contributed by [cwkeam](https://huggingface.co/cwkeam). The original code can be found [here](https://github.com/flashlight/wav2letter/tree/main/recipes/mling_pl). +## Documentation resources + +- [Automatic speech recognition task guide](./tasks/asr) Tips: diff --git a/docs/source/en/model_doc/megatron-bert.mdx b/docs/source/en/model_doc/megatron-bert.mdx index 911bf76aec..b3e09de9b4 100644 --- a/docs/source/en/model_doc/megatron-bert.mdx +++ b/docs/source/en/model_doc/megatron-bert.mdx @@ -78,6 +78,15 @@ This model was contributed by [jdemouth](https://huggingface.co/jdemouth). The o Megatron Language models. In particular, it contains a hybrid model parallel approach using "tensor parallel" and "pipeline parallel" techniques. +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## MegatronBertConfig [[autodoc]] MegatronBertConfig diff --git a/docs/source/en/model_doc/mobilebert.mdx b/docs/source/en/model_doc/mobilebert.mdx index 8305903d23..7fb2c7c4c4 100644 --- a/docs/source/en/model_doc/mobilebert.mdx +++ b/docs/source/en/model_doc/mobilebert.mdx @@ -43,6 +43,14 @@ Tips: This model was contributed by [vshampor](https://huggingface.co/vshampor). The original code can be found [here](https://github.com/google-research/mobilebert). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## MobileBertConfig [[autodoc]] MobileBertConfig diff --git a/docs/source/en/model_doc/mobilenet_v1.mdx b/docs/source/en/model_doc/mobilenet_v1.mdx index 48795896f0..902040f208 100644 --- a/docs/source/en/model_doc/mobilenet_v1.mdx +++ b/docs/source/en/model_doc/mobilenet_v1.mdx @@ -51,6 +51,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`MobileNetV1ForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/mobilenet_v2.mdx b/docs/source/en/model_doc/mobilenet_v2.mdx index 6f179f3cee..356a9cb8d4 100644 --- a/docs/source/en/model_doc/mobilenet_v2.mdx +++ b/docs/source/en/model_doc/mobilenet_v2.mdx @@ -55,6 +55,10 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`MobileNetV2ForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) + +**Semantic segmentation** +- [Semantic segmentation task guide](./tasks/semantic_segmentation) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/mobilevit.mdx b/docs/source/en/model_doc/mobilevit.mdx index 6c0b5b6aae..1d627abf95 100644 --- a/docs/source/en/model_doc/mobilevit.mdx +++ b/docs/source/en/model_doc/mobilevit.mdx @@ -64,6 +64,10 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`MobileViTForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) + +**Semantic segmentation** +- [Semantic segmentation task guide](./tasks/semantic_segmentation) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/mpnet.mdx b/docs/source/en/model_doc/mpnet.mdx index 0fa88ee87b..134dbef7e1 100644 --- a/docs/source/en/model_doc/mpnet.mdx +++ b/docs/source/en/model_doc/mpnet.mdx @@ -40,6 +40,14 @@ Tips: The original code can be found [here](https://github.com/microsoft/MPNet). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## MPNetConfig [[autodoc]] MPNetConfig diff --git a/docs/source/en/model_doc/mt5.mdx b/docs/source/en/model_doc/mt5.mdx index 0da6a6a7f3..93fac60bba 100644 --- a/docs/source/en/model_doc/mt5.mdx +++ b/docs/source/en/model_doc/mt5.mdx @@ -56,6 +56,11 @@ Google has released the following variants: This model was contributed by [patrickvonplaten](https://huggingface.co/patrickvonplaten). The original code can be found [here](https://github.com/google-research/multilingual-t5). +## Documentation resources + +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) + ## MT5Config [[autodoc]] MT5Config diff --git a/docs/source/en/model_doc/mvp.mdx b/docs/source/en/model_doc/mvp.mdx index 6fae8c7311..8cff270c01 100644 --- a/docs/source/en/model_doc/mvp.mdx +++ b/docs/source/en/model_doc/mvp.mdx @@ -100,6 +100,15 @@ For lightweight tuning, *i.e.*, fixing the model and only tuning prompts, you ca >>> model.set_lightweight_tuning() ``` +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) + ## MvpConfig [[autodoc]] MvpConfig diff --git a/docs/source/en/model_doc/nat.mdx b/docs/source/en/model_doc/nat.mdx index 636b984c6a..25ac86368a 100644 --- a/docs/source/en/model_doc/nat.mdx +++ b/docs/source/en/model_doc/nat.mdx @@ -63,6 +63,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`NatForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/nezha.mdx b/docs/source/en/model_doc/nezha.mdx index 8b613c38eb..557e03113d 100644 --- a/docs/source/en/model_doc/nezha.mdx +++ b/docs/source/en/model_doc/nezha.mdx @@ -31,6 +31,14 @@ and natural language inference (XNLI).* This model was contributed by [sijunhe](https://huggingface.co/sijunhe). The original code can be found [here](https://github.com/huawei-noah/Pretrained-Language-Model/tree/master/NEZHA-PyTorch). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## NezhaConfig [[autodoc]] NezhaConfig diff --git a/docs/source/en/model_doc/nllb.mdx b/docs/source/en/model_doc/nllb.mdx index d2c0089fa3..6b935a89aa 100644 --- a/docs/source/en/model_doc/nllb.mdx +++ b/docs/source/en/model_doc/nllb.mdx @@ -88,6 +88,11 @@ See example below for a translation from romanian to german: UN-Chef sagt, es gibt keine militΓ€rische LΓΆsung in Syrien ``` +## Documentation resources + +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) + ## NllbTokenizer [[autodoc]] NllbTokenizer diff --git a/docs/source/en/model_doc/nystromformer.mdx b/docs/source/en/model_doc/nystromformer.mdx index 5c1619b57f..2c78892d8d 100644 --- a/docs/source/en/model_doc/nystromformer.mdx +++ b/docs/source/en/model_doc/nystromformer.mdx @@ -33,6 +33,14 @@ favorably relative to other efficient self-attention methods. Our code is availa This model was contributed by [novice03](https://huggingface.co/novice03). The original code can be found [here](https://github.com/mlpen/Nystromformer). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## NystromformerConfig [[autodoc]] NystromformerConfig diff --git a/docs/source/en/model_doc/openai-gpt.mdx b/docs/source/en/model_doc/openai-gpt.mdx index 0c444b5a4f..3adb22f0ab 100644 --- a/docs/source/en/model_doc/openai-gpt.mdx +++ b/docs/source/en/model_doc/openai-gpt.mdx @@ -73,6 +73,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - A blog post on [outperforming OpenAI GPT-3 with SetFit for text-classification](https://www.philschmid.de/getting-started-setfit). +- See also: [Text classification task guide](./tasks/sequence_classification) @@ -86,6 +87,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [Causal language modeling](https://huggingface.co/course/en/chapter7/6?fw=pt#training-a-causal-language-model-from-scratch) chapter of the πŸ€— Hugging Face Course. - [`OpenAIGPTLMHeadModel`] is supported by this [causal language modeling example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/language-modeling#gpt-2gpt-and-causal-language-modeling), [text generation example script](https://github.com/huggingface/transformers/blob/main/examples/pytorch/text-generation/run_generation.py) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling.ipynb). - [`TFOpenAIGPTLMHeadModel`] is supported by this [causal language modeling example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling#run_clmpy) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling-tf.ipynb). +- See also: [Causal language modeling task guide](./tasks/language_modeling) diff --git a/docs/source/en/model_doc/opt.mdx b/docs/source/en/model_doc/opt.mdx index 6bf8135217..0c041c5ecb 100644 --- a/docs/source/en/model_doc/opt.mdx +++ b/docs/source/en/model_doc/opt.mdx @@ -45,7 +45,7 @@ The resource should ideally demonstrate something new instead of duplicating an -- [Token classification](https://huggingface.co/course/chapter7/2?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Text classification task guide](sequence_classification.mdx) - [`OPTForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification.ipynb). @@ -56,7 +56,7 @@ The resource should ideally demonstrate something new instead of duplicating an ⚑️ Inference -- A blog bost on [How πŸ€— Accelerate runs very large models thanks to PyTorch](https://huggingface.co/blog/accelerate-large-models) with OPT. +- A blog post on [How πŸ€— Accelerate runs very large models thanks to PyTorch](https://huggingface.co/blog/accelerate-large-models) with OPT. ## OPTConfig diff --git a/docs/source/en/model_doc/pegasus.mdx b/docs/source/en/model_doc/pegasus.mdx index 09d7cfd5d6..fe00ab203e 100644 --- a/docs/source/en/model_doc/pegasus.mdx +++ b/docs/source/en/model_doc/pegasus.mdx @@ -102,6 +102,12 @@ All the [checkpoints](https://huggingface.co/models?search=pegasus) are fine-tun ... ) ``` +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) + ## PegasusConfig [[autodoc]] PegasusConfig diff --git a/docs/source/en/model_doc/pegasus_x.mdx b/docs/source/en/model_doc/pegasus_x.mdx index c3527c9e01..f9aeb46438 100644 --- a/docs/source/en/model_doc/pegasus_x.mdx +++ b/docs/source/en/model_doc/pegasus_x.mdx @@ -28,6 +28,11 @@ Tips: This model was contributed by [zphang]( - [`PoolFormerForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/prophetnet.mdx b/docs/source/en/model_doc/prophetnet.mdx index 193a731e7c..c49c659a28 100644 --- a/docs/source/en/model_doc/prophetnet.mdx +++ b/docs/source/en/model_doc/prophetnet.mdx @@ -53,6 +53,11 @@ Tips: The Authors' code can be found [here](https://github.com/microsoft/ProphetNet). +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) ## ProphetNetConfig diff --git a/docs/source/en/model_doc/qdqbert.mdx b/docs/source/en/model_doc/qdqbert.mdx index df7b7bcee6..76c35b60c4 100644 --- a/docs/source/en/model_doc/qdqbert.mdx +++ b/docs/source/en/model_doc/qdqbert.mdx @@ -114,6 +114,15 @@ the instructions in [torch.onnx](https://pytorch.org/docs/stable/onnx.html). Exa >>> torch.onnx.export(...) ``` +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## QDQBertConfig [[autodoc]] QDQBertConfig diff --git a/docs/source/en/model_doc/reformer.mdx b/docs/source/en/model_doc/reformer.mdx index 2d4b5511a5..b53eaa4e74 100644 --- a/docs/source/en/model_doc/reformer.mdx +++ b/docs/source/en/model_doc/reformer.mdx @@ -151,6 +151,13 @@ input_ids = tokenizer.encode("This is a sentence from the training data", return loss = model(input_ids, labels=input_ids)[0] ``` +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) + ## ReformerConfig [[autodoc]] ReformerConfig diff --git a/docs/source/en/model_doc/regnet.mdx b/docs/source/en/model_doc/regnet.mdx index 62d030452a..e93eec6216 100644 --- a/docs/source/en/model_doc/regnet.mdx +++ b/docs/source/en/model_doc/regnet.mdx @@ -38,6 +38,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`RegNetForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/rembert.mdx b/docs/source/en/model_doc/rembert.mdx index 0edb8e5202..fa3c16f90d 100644 --- a/docs/source/en/model_doc/rembert.mdx +++ b/docs/source/en/model_doc/rembert.mdx @@ -37,6 +37,15 @@ embedding layer. The embeddings are not tied in pre-training, in contrast with B embeddings (preserved during fine-tuning) and bigger output embeddings (discarded at fine-tuning). The tokenizer is also similar to the Albert one rather than the BERT one. +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## RemBertConfig [[autodoc]] RemBertConfig diff --git a/docs/source/en/model_doc/resnet.mdx b/docs/source/en/model_doc/resnet.mdx index 031066b69b..fd954967e5 100644 --- a/docs/source/en/model_doc/resnet.mdx +++ b/docs/source/en/model_doc/resnet.mdx @@ -40,6 +40,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`ResNetForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/roberta-prelayernorm.mdx b/docs/source/en/model_doc/roberta-prelayernorm.mdx index a8fb2bb2b9..2a2d01c1c7 100644 --- a/docs/source/en/model_doc/roberta-prelayernorm.mdx +++ b/docs/source/en/model_doc/roberta-prelayernorm.mdx @@ -29,6 +29,14 @@ Tips: This model was contributed by [andreasmaden](https://huggingface.co/andreasmaden). The original code can be found [here](https://github.com/princeton-nlp/DinkyTrain). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## RobertaPreLayerNormConfig diff --git a/docs/source/en/model_doc/roberta.mdx b/docs/source/en/model_doc/roberta.mdx index 63b7bab6fa..622853ab89 100644 --- a/docs/source/en/model_doc/roberta.mdx +++ b/docs/source/en/model_doc/roberta.mdx @@ -70,6 +70,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`RobertaForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification.ipynb). - [`TFRobertaForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification-tf.ipynb). - [`FlaxRobertaForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification_flax.ipynb). +- [Text classification task guide](./tasks/sequence_classification) @@ -77,6 +78,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFRobertaForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/token-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/token_classification-tf.ipynb). - [`FlaxRobertaForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/token-classification). - [Token classification](https://huggingface.co/course/chapter7/2?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Token classification task guide](./tasks/token_classification) @@ -85,6 +87,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFRobertaForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling#run_mlmpy) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling-tf.ipynb). - [`FlaxRobertaForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/language-modeling#masked-language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/masked_language_modeling_flax.ipynb). - [Masked language modeling](https://huggingface.co/course/chapter7/3?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Masked language modeling task guide](./tasks/masked_language_modeling) @@ -93,10 +96,12 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFRobertaForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/question-answering) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/question_answering-tf.ipynb). - [`FlaxRobertaForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/question-answering). - [Question answering](https://huggingface.co/course/chapter7/7?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Question answering task guide](./tasks/question_answering) **Multiple choice** - [`RobertaForMultipleChoice`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/multiple-choice) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/multiple_choice.ipynb). - [`TFRobertaForMultipleChoice`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/multiple-choice) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/multiple_choice-tf.ipynb). +- [Multiple choice task guide](./tasks/multiple_choice) ## RobertaConfig diff --git a/docs/source/en/model_doc/roc_bert.mdx b/docs/source/en/model_doc/roc_bert.mdx index c30ccfd1c5..42ff072e74 100644 --- a/docs/source/en/model_doc/roc_bert.mdx +++ b/docs/source/en/model_doc/roc_bert.mdx @@ -31,6 +31,15 @@ in the toxic content detection task under human-made attacks.* This model was contributed by [weiweishi](https://huggingface.co/weiweishi). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## RoCBertConfig [[autodoc]] RoCBertConfig diff --git a/docs/source/en/model_doc/roformer.mdx b/docs/source/en/model_doc/roformer.mdx index 435941d9f2..7940a5e24f 100644 --- a/docs/source/en/model_doc/roformer.mdx +++ b/docs/source/en/model_doc/roformer.mdx @@ -37,6 +37,15 @@ Tips: This model was contributed by [junnyu](https://huggingface.co/junnyu). The original code can be found [here](https://github.com/ZhuiyiTechnology/roformer). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## RoFormerConfig [[autodoc]] RoFormerConfig diff --git a/docs/source/en/model_doc/segformer.mdx b/docs/source/en/model_doc/segformer.mdx index 5c494e4747..a529578947 100644 --- a/docs/source/en/model_doc/segformer.mdx +++ b/docs/source/en/model_doc/segformer.mdx @@ -91,6 +91,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`SegformerForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- [Image classification task guide](./tasks/image_classification) Semantic segmentation: @@ -98,6 +99,7 @@ Semantic segmentation: - A blog on fine-tuning SegFormer on a custom dataset can be found [here](https://huggingface.co/blog/fine-tune-segformer). - More demo notebooks on SegFormer (both inference + fine-tuning on a custom dataset) can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/SegFormer). - [`TFSegformerForSemanticSegmentation`] is supported by this [example notebook](https://github.com/huggingface/notebooks/blob/main/examples/semantic_segmentation-tf.ipynb). +- [Semantic segmentation task guide](./tasks/semantic_segmentation) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/sew-d.mdx b/docs/source/en/model_doc/sew-d.mdx index ceeb4f1ec3..c28c08773e 100644 --- a/docs/source/en/model_doc/sew-d.mdx +++ b/docs/source/en/model_doc/sew-d.mdx @@ -36,6 +36,10 @@ Tips: This model was contributed by [anton-l](https://huggingface.co/anton-l). +## Documentation resources + +- [Audio classification task guide](./tasks/audio_classification) +- [Automatic speech recognition task guide](./tasks/asr) ## SEWDConfig diff --git a/docs/source/en/model_doc/sew.mdx b/docs/source/en/model_doc/sew.mdx index dce949a856..d37393f732 100644 --- a/docs/source/en/model_doc/sew.mdx +++ b/docs/source/en/model_doc/sew.mdx @@ -36,6 +36,10 @@ Tips: This model was contributed by [anton-l](https://huggingface.co/anton-l). +## Documentation resources + +- [Audio classification task guide](./tasks/audio_classification) +- [Automatic speech recognition task guide](./tasks/asr) ## SEWConfig diff --git a/docs/source/en/model_doc/speech_to_text_2.mdx b/docs/source/en/model_doc/speech_to_text_2.mdx index 2e3ebc3f39..87d7dde1be 100644 --- a/docs/source/en/model_doc/speech_to_text_2.mdx +++ b/docs/source/en/model_doc/speech_to_text_2.mdx @@ -94,6 +94,9 @@ predicted token ids. See [model hub](https://huggingface.co/models?filter=speech2text2) to look for Speech2Text2 checkpoints. +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) ## Speech2Text2Config diff --git a/docs/source/en/model_doc/splinter.mdx b/docs/source/en/model_doc/splinter.mdx index 55e5f61b8d..329b53ccc5 100644 --- a/docs/source/en/model_doc/splinter.mdx +++ b/docs/source/en/model_doc/splinter.mdx @@ -47,6 +47,10 @@ Tips: This model was contributed by [yuvalkirstain](https://huggingface.co/yuvalkirstain) and [oriram](https://huggingface.co/oriram). The original code can be found [here](https://github.com/oriram/splinter). +## Documentation resources + +- [Question answering task guide](./tasks/question-answering) + ## SplinterConfig [[autodoc]] SplinterConfig diff --git a/docs/source/en/model_doc/squeezebert.mdx b/docs/source/en/model_doc/squeezebert.mdx index c6219582c8..e793346cce 100644 --- a/docs/source/en/model_doc/squeezebert.mdx +++ b/docs/source/en/model_doc/squeezebert.mdx @@ -46,6 +46,13 @@ Tips: This model was contributed by [forresti](https://huggingface.co/forresti). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## SqueezeBertConfig diff --git a/docs/source/en/model_doc/swin.mdx b/docs/source/en/model_doc/swin.mdx index 1bb4fb88d8..a7aa0537c7 100644 --- a/docs/source/en/model_doc/swin.mdx +++ b/docs/source/en/model_doc/swin.mdx @@ -52,6 +52,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`SwinForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) Besides that: diff --git a/docs/source/en/model_doc/swinv2.mdx b/docs/source/en/model_doc/swinv2.mdx index c4378583c4..703880cc08 100644 --- a/docs/source/en/model_doc/swinv2.mdx +++ b/docs/source/en/model_doc/swinv2.mdx @@ -33,6 +33,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`Swinv2ForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) Besides that: diff --git a/docs/source/en/model_doc/switch_transformers.mdx b/docs/source/en/model_doc/switch_transformers.mdx index 348c831a0e..30a45aca36 100644 --- a/docs/source/en/model_doc/switch_transformers.mdx +++ b/docs/source/en/model_doc/switch_transformers.mdx @@ -32,6 +32,10 @@ Tips: This model was contributed by [Younes Belkada](https://huggingface.co/ybelkada) and [Arthur Zucker](https://huggingface.co/ArtZucker) . The original code can be found [here](https://github.com/google/flaxformer/tree/main/flaxformer/architectures/moe). +## Resources + +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) ## SwitchTransformersConfig diff --git a/docs/source/en/model_doc/t5.mdx b/docs/source/en/model_doc/t5.mdx index 472d10be23..576de4d62b 100644 --- a/docs/source/en/model_doc/t5.mdx +++ b/docs/source/en/model_doc/t5.mdx @@ -333,6 +333,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFT5ForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/summarization) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/summarization-tf.ipynb). - [`FlaxT5ForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/summarization). - [Summarization](https://huggingface.co/course/chapter7/5?fw=pt#summarization) chapter of the πŸ€— Hugging Face course. +- [Summarization task guide](./tasks/summarization) @@ -342,6 +343,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`T5ForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/translation) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/translation.ipynb). - [`TFT5ForConditionalGeneration`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/translation) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/translation-tf.ipynb). +- [Translation task guide](./tasks/translation) diff --git a/docs/source/en/model_doc/table-transformer.mdx b/docs/source/en/model_doc/table-transformer.mdx index 862f4124c2..07197f233d 100644 --- a/docs/source/en/model_doc/table-transformer.mdx +++ b/docs/source/en/model_doc/table-transformer.mdx @@ -47,7 +47,7 @@ found [here](https://github.com/microsoft/table-transformer). - A demo notebook for the Table Transformer can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/Table%20Transformer). -- It turns out padding of images is quite important for detection. An interesting Github thread with replies from the authors can be found [here](https://github.com/microsoft/table-transformer/issues/68). +- It turns out padding of images is quite important for detection. An interesting Github thread with replies from the authors can be found [here](https://github.com/microsoft/table-transformer/issues/68). ## TableTransformerConfig diff --git a/docs/source/en/model_doc/tapas.mdx b/docs/source/en/model_doc/tapas.mdx index 5a2b54e8c3..e7e6608965 100644 --- a/docs/source/en/model_doc/tapas.mdx +++ b/docs/source/en/model_doc/tapas.mdx @@ -569,6 +569,11 @@ Predicted answer: SUM > 87, 53, 69 In case of a conversational set-up, then each table-question pair must be provided **sequentially** to the model, such that the `prev_labels` token types can be overwritten by the predicted `labels` of the previous table-question pair. Again, more info can be found in [this notebook](https://github.com/NielsRogge/Transformers-Tutorials/blob/master/TAPAS/Fine_tuning_TapasForQuestionAnswering_on_SQA.ipynb) (for PyTorch) and [this notebook](https://github.com/kamalkraj/Tapas-Tutorial/blob/master/TAPAS/Fine_tuning_TapasForQuestionAnswering_on_SQA.ipynb) (for TensorFlow). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Masked language modeling task guide](./tasks/masked_language_modeling) + ## TAPAS specific outputs [[autodoc]] models.tapas.modeling_tapas.TableQuestionAnsweringOutput diff --git a/docs/source/en/model_doc/timesformer.mdx b/docs/source/en/model_doc/timesformer.mdx index 602ec4f4f2..7591d1fbc9 100644 --- a/docs/source/en/model_doc/timesformer.mdx +++ b/docs/source/en/model_doc/timesformer.mdx @@ -28,6 +28,9 @@ There are many pretrained variants. Select your pretrained model based on the da This model was contributed by [fcakyon](https://huggingface.co/fcakyon). The original code can be found [here](https://github.com/facebookresearch/TimeSformer). +## Documentation resources + +- [Video classification task guide](./tasks/video_classification) ## TimesformerConfig diff --git a/docs/source/en/model_doc/transfo-xl.mdx b/docs/source/en/model_doc/transfo-xl.mdx index 34b8cc8e9f..bfd99cf1aa 100644 --- a/docs/source/en/model_doc/transfo-xl.mdx +++ b/docs/source/en/model_doc/transfo-xl.mdx @@ -58,6 +58,10 @@ TransformerXL does **not** work with *torch.nn.DataParallel* due to a bug in PyT +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Causal language modeling task guide](./tasks/language_modeling) ## TransfoXLConfig diff --git a/docs/source/en/model_doc/unispeech-sat.mdx b/docs/source/en/model_doc/unispeech-sat.mdx index e2ceb783ea..72400a0363 100644 --- a/docs/source/en/model_doc/unispeech-sat.mdx +++ b/docs/source/en/model_doc/unispeech-sat.mdx @@ -44,6 +44,10 @@ Tips: This model was contributed by [patrickvonplaten](https://huggingface.co/patrickvonplaten). The Authors' code can be found [here](https://github.com/microsoft/UniSpeech/tree/main/UniSpeech-SAT). +## Documentation resources + +- [Audio classification task guide](./tasks/audio_classification) +- [Automatic speech recognition task guide](./tasks/asr) ## UniSpeechSatConfig diff --git a/docs/source/en/model_doc/unispeech.mdx b/docs/source/en/model_doc/unispeech.mdx index 37d0a0a708..6deb274b2f 100644 --- a/docs/source/en/model_doc/unispeech.mdx +++ b/docs/source/en/model_doc/unispeech.mdx @@ -39,6 +39,10 @@ Tips: This model was contributed by [patrickvonplaten](https://huggingface.co/patrickvonplaten). The Authors' code can be found [here](https://github.com/microsoft/UniSpeech/tree/main/UniSpeech). +## Documentation resources + +- [Audio classification task guide](./tasks/audio_classification) +- [Automatic speech recognition task guide](./tasks/asr) ## UniSpeechConfig diff --git a/docs/source/en/model_doc/upernet.mdx b/docs/source/en/model_doc/upernet.mdx index 17dff3c66a..074189599b 100644 --- a/docs/source/en/model_doc/upernet.mdx +++ b/docs/source/en/model_doc/upernet.mdx @@ -35,6 +35,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - Demo notebooks for UPerNet can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/UPerNet). - [`UperNetForSemanticSegmentation`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/semantic-segmentation) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/semantic_segmentation.ipynb). +- See also: [Semantic segmentation task guide](./tasks/semantic_segmentation) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/van.mdx b/docs/source/en/model_doc/van.mdx index 1f5507244c..e6f021cd9f 100644 --- a/docs/source/en/model_doc/van.mdx +++ b/docs/source/en/model_doc/van.mdx @@ -39,6 +39,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`VanForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/videomae.mdx b/docs/source/en/model_doc/videomae.mdx index 76e822ef8a..efa1ed14fe 100644 --- a/docs/source/en/model_doc/videomae.mdx +++ b/docs/source/en/model_doc/videomae.mdx @@ -43,7 +43,7 @@ review it! The resource should ideally demonstrate something new instead of dupl **Video classification** - [A notebook](https://github.com/huggingface/notebooks/blob/main/examples/video_classification.ipynb) that shows how to fine-tune a VideoMAE model on a custom dataset. -- [Video classification task page](https://huggingface.co/tasks/video-classification) +- [Video classification task guide](./tasks/video-classification) - [A πŸ€— Space](https://huggingface.co/spaces/sayakpaul/video-classification-ucf101-subset) showing how to perform inference with a video classification model. diff --git a/docs/source/en/model_doc/vit.mdx b/docs/source/en/model_doc/vit.mdx index 45ed3f1878..0244c66402 100644 --- a/docs/source/en/model_doc/vit.mdx +++ b/docs/source/en/model_doc/vit.mdx @@ -95,6 +95,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`ViTForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). - A blog on fine-tuning [`ViTForImageClassification`] on a custom dataset can be found [here](https://huggingface.co/blog/fine-tune-vit). - More demo notebooks to fine-tune [`ViTForImageClassification`] can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/VisionTransformer). +- [Image classification task guide](./tasks/image_classification) Besides that: diff --git a/docs/source/en/model_doc/vit_hybrid.mdx b/docs/source/en/model_doc/vit_hybrid.mdx index 8885af0dfe..07377bdb3f 100644 --- a/docs/source/en/model_doc/vit_hybrid.mdx +++ b/docs/source/en/model_doc/vit_hybrid.mdx @@ -44,6 +44,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`ViTHybridForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/vit_msn.mdx b/docs/source/en/model_doc/vit_msn.mdx index 47c1f69e2b..41c2ff32d5 100644 --- a/docs/source/en/model_doc/vit_msn.mdx +++ b/docs/source/en/model_doc/vit_msn.mdx @@ -53,6 +53,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`ViTMSNForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb). +- See also: [Image classification task guide](./tasks/image_classification) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/wav2vec2-conformer.mdx b/docs/source/en/model_doc/wav2vec2-conformer.mdx index 2cfb38553f..29f2ace678 100644 --- a/docs/source/en/model_doc/wav2vec2-conformer.mdx +++ b/docs/source/en/model_doc/wav2vec2-conformer.mdx @@ -33,6 +33,10 @@ an improved word error rate. This model was contributed by [patrickvonplaten](https://huggingface.co/patrickvonplaten). The original code can be found [here](https://github.com/pytorch/fairseq/tree/main/examples/wav2vec). +## Documentation resources + +- [Audio classification task guide](./tasks/audio_classification) +- [Automatic speech recognition task guide](./tasks/asr) ## Wav2Vec2ConformerConfig diff --git a/docs/source/en/model_doc/wav2vec2.mdx b/docs/source/en/model_doc/wav2vec2.mdx index 3acf176a27..43210fd0ae 100644 --- a/docs/source/en/model_doc/wav2vec2.mdx +++ b/docs/source/en/model_doc/wav2vec2.mdx @@ -43,6 +43,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - A notebook on how to [leverage a pretrained Wav2Vec2 model for emotion classification](https://colab.research.google.com/github/m3hrdadfi/soxan/blob/main/notebooks/Emotion_recognition_in_Greek_speech_using_Wav2Vec2.ipynb). 🌎 - [`Wav2Vec2ForCTC`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/audio-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/audio_classification.ipynb). +- [Audio classification task guide](./tasks/audio_classification) @@ -51,6 +52,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - A blog post on [finetuning XLS-R for Multi-Lingual ASR with πŸ€— Transformers](https://huggingface.co/blog/fine-tune-xlsr-wav2vec2). - A notebook on how to [create YouTube captions from any video by transcribing audio with Wav2Vec2](https://colab.research.google.com/github/Muennighoff/ytclipcc/blob/main/wav2vec_youtube_captions.ipynb). 🌎 - [`Wav2Vec2ForCTC`] is supported by a notebook on [how to finetune a speech recognition model in English](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/speech_recognition.ipynb), and [how to finetune a speech recognition model in any language](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/multi_lingual_speech_recognition.ipynb). +- [Automatic speech recognition task guide](./tasks/asr) πŸš€ Deploy diff --git a/docs/source/en/model_doc/wavlm.mdx b/docs/source/en/model_doc/wavlm.mdx index 8e2138a611..1157842f93 100644 --- a/docs/source/en/model_doc/wavlm.mdx +++ b/docs/source/en/model_doc/wavlm.mdx @@ -44,6 +44,10 @@ Relevant checkpoints can be found under https://huggingface.co/models?other=wavl This model was contributed by [patrickvonplaten](https://huggingface.co/patrickvonplaten). The Authors' code can be found [here](https://github.com/microsoft/unilm/tree/master/wavlm). +## Documentation resources + +- [Audio classification task guide](./tasks/audio_classification) +- [Automatic speech recognition task guide](./tasks/asr) ## WavLMConfig diff --git a/docs/source/en/model_doc/xglm.mdx b/docs/source/en/model_doc/xglm.mdx index e35bab25f8..a9883847fb 100644 --- a/docs/source/en/model_doc/xglm.mdx +++ b/docs/source/en/model_doc/xglm.mdx @@ -38,6 +38,10 @@ in social value tasks such as hate speech detection in five languages and find i This model was contributed by [Suraj](https://huggingface.co/valhalla). The original code can be found [here](https://github.com/pytorch/fairseq/tree/main/examples/xglm). +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) + ## XGLMConfig [[autodoc]] XGLMConfig diff --git a/docs/source/en/model_doc/xlm-prophetnet.mdx b/docs/source/en/model_doc/xlm-prophetnet.mdx index 699f9192c2..1bfae1ec42 100644 --- a/docs/source/en/model_doc/xlm-prophetnet.mdx +++ b/docs/source/en/model_doc/xlm-prophetnet.mdx @@ -52,6 +52,12 @@ Tips: - XLM-ProphetNet's model architecture and pretraining objective is same as ProphetNet, but XLM-ProphetNet was pre-trained on the cross-lingual dataset XGLUE. +## Documentation resources + +- [Causal language modeling task guide](./tasks/language_modeling) +- [Translation task guide](./tasks/translation) +- [Summarization task guide](./tasks/summarization) + ## XLMProphetNetConfig [[autodoc]] XLMProphetNetConfig diff --git a/docs/source/en/model_doc/xlm-roberta-xl.mdx b/docs/source/en/model_doc/xlm-roberta-xl.mdx index 01829a128c..ebda86e19c 100644 --- a/docs/source/en/model_doc/xlm-roberta-xl.mdx +++ b/docs/source/en/model_doc/xlm-roberta-xl.mdx @@ -28,6 +28,14 @@ Tips: This model was contributed by [Soonhwan-Kwon](https://github.com/Soonhwan-Kwon) and [stefan-it](https://huggingface.co/stefan-it). The original code can be found [here](https://github.com/pytorch/fairseq/tree/master/examples/xlmr). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## XLMRobertaXLConfig diff --git a/docs/source/en/model_doc/xlm-roberta.mdx b/docs/source/en/model_doc/xlm-roberta.mdx index 0a61d5c67a..81aef3e9eb 100644 --- a/docs/source/en/model_doc/xlm-roberta.mdx +++ b/docs/source/en/model_doc/xlm-roberta.mdx @@ -64,6 +64,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFXLMRobertaForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification-tf.ipynb). - [`FlaxXLMRobertaForSequenceClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/text-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/text_classification_flax.ipynb). - [Text classification](https://huggingface.co/docs/transformers/tasks/sequence_classification) chapter of the πŸ€— Hugging Face Task Guides. +- [Text classification task guide](./tasks/sequence_classification) @@ -71,11 +72,13 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFXLMRobertaForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/token-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/token_classification-tf.ipynb). - [`FlaxXLMRobertaForTokenClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/token-classification). - [Token classification](https://huggingface.co/course/chapter7/2?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Token classification task guide](./tasks/token_classification) - [`XLMRobertaForCausalLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling.ipynb). -- [Causal language modeling](https://huggingface.co/docs/transformers/tasks/language_modeling) chapter of the πŸ€— Hugging Face Task Guides. +- [Causal language modeling](https://huggingface.co/docs/transformers/tasks/language_modeling) chapter of the πŸ€— Hugging Face Task Guides. +- [Causal language modeling task guide](./tasks/language_modeling) @@ -83,6 +86,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFXLMRobertaForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling#run_mlmpy) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/language_modeling-tf.ipynb). - [`FlaxXLMRobertaForMaskedLM`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/language-modeling#masked-language-modeling) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/masked_language_modeling_flax.ipynb). - [Masked language modeling](https://huggingface.co/course/chapter7/3?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Masked language modeling](./tasks/masked_language_modeling) @@ -90,11 +94,13 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - [`TFXLMRobertaForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/question-answering) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/question_answering-tf.ipynb). - [`FlaxXLMRobertaForQuestionAnswering`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/flax/question-answering). - [Question answering](https://huggingface.co/course/chapter7/7?fw=pt) chapter of the πŸ€— Hugging Face Course. +- [Question answering task guide](./tasks/question_answering) **Multiple choice** - [`XLMRobertaForMultipleChoice`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/multiple-choice) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/multiple_choice.ipynb). - [`TFXLMRobertaForMultipleChoice`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/multiple-choice) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/multiple_choice-tf.ipynb). +- [Multiple choice task guide](./tasks/multiple_choice) πŸš€ Deploy diff --git a/docs/source/en/model_doc/xlm.mdx b/docs/source/en/model_doc/xlm.mdx index 18ce89cefd..04923d2285 100644 --- a/docs/source/en/model_doc/xlm.mdx +++ b/docs/source/en/model_doc/xlm.mdx @@ -55,6 +55,14 @@ Tips: This model was contributed by [thomwolf](https://huggingface.co/thomwolf). The original code can be found [here](https://github.com/facebookresearch/XLM/). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## XLMConfig diff --git a/docs/source/en/model_doc/xlnet.mdx b/docs/source/en/model_doc/xlnet.mdx index 694ae3ca27..2bebc4719b 100644 --- a/docs/source/en/model_doc/xlnet.mdx +++ b/docs/source/en/model_doc/xlnet.mdx @@ -54,6 +54,13 @@ Tips: This model was contributed by [thomwolf](https://huggingface.co/thomwolf). The original code can be found [here](https://github.com/zihangdai/xlnet/). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## XLNetConfig diff --git a/docs/source/en/model_doc/xmod.mdx b/docs/source/en/model_doc/xmod.mdx index ffc1c85dcb..7c65734692 100644 --- a/docs/source/en/model_doc/xmod.mdx +++ b/docs/source/en/model_doc/xmod.mdx @@ -78,6 +78,15 @@ model.set_default_language("de_DE") # Evaluate the model on German examples ... ``` +## Resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Causal language modeling task guide](./tasks/language_modeling) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) + ## XmodConfig [[autodoc]] XmodConfig diff --git a/docs/source/en/model_doc/yolos.mdx b/docs/source/en/model_doc/yolos.mdx index 66533bacfb..bab338860e 100644 --- a/docs/source/en/model_doc/yolos.mdx +++ b/docs/source/en/model_doc/yolos.mdx @@ -39,6 +39,7 @@ A list of official Hugging Face and community (indicated by 🌎) resources to h - All example notebooks illustrating inference + fine-tuning [`YolosForObjectDetection`] on a custom dataset can be found [here](https://github.com/NielsRogge/Transformers-Tutorials/tree/master/YOLOS). +- See also: [Object detection task guide](./tasks/object_detection) If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. diff --git a/docs/source/en/model_doc/yoso.mdx b/docs/source/en/model_doc/yoso.mdx index 997ab4d094..575c1b4916 100644 --- a/docs/source/en/model_doc/yoso.mdx +++ b/docs/source/en/model_doc/yoso.mdx @@ -50,6 +50,13 @@ alt="drawing" width="600"/> This model was contributed by [novice03](https://huggingface.co/novice03). The original code can be found [here](https://github.com/mlpen/YOSO). +## Documentation resources + +- [Text classification task guide](./tasks/sequence_classification) +- [Token classification task guide](./tasks/token_classification) +- [Question answering task guide](./tasks/question_answering) +- [Masked language modeling task guide](./tasks/masked_language_modeling) +- [Multiple choice task guide](./tasks/multiple_choice) ## YosoConfig