Skip to content

GitLab

"...git@developer.sourcefind.cn:chenpangpang/transformers.git" did not exist on "d4407a3bd13b8ec3978b9ba8e4e45cb11f230437"
Unverified Commit 151a2aaa authored by Steven Liu's avatar Steven Liu Committed by GitHub
Browse files

Split model list on modality (#18328) 

* 📝

 split up model list

* Adapt script to reorg

* apply niels feedback
Co-authored-by: default avatarSylvain Gugger <Sylvain.gugger@gmail.com>
parent 01db72ab
Show whitespace changes
Inline Side-by-side
Showing with 307 additions and 282 deletions
docs/source/en/_toctree.yml
View file @ 151a2aaa
...@@ -164,18 +164,18 @@ ...@@ -164,18 +164,18 @@
title: Feature Extractor title: Feature Extractor
title: Main Classes title: Main Classes
- sections: - sections:
- local: model_doc/albert
title: ALBERT
- local: model_doc/auto - local: model_doc/auto
title: Auto Classes title: Auto Classes
- isExpanded: false
sections:
- local: model_doc/albert
title: ALBERT
- local: model_doc/bart - local: model_doc/bart
title: BART title: BART
- local: model_doc/barthez - local: model_doc/barthez
title: BARThez title: BARThez
- local: model_doc/bartpho - local: model_doc/bartpho
title: BARTpho title: BARTpho
- local: model_doc/beit
title: BEiT
- local: model_doc/bert - local: model_doc/bert
title: BERT title: BERT
- local: model_doc/bert-generation - local: model_doc/bert-generation
...@@ -202,58 +202,36 @@ ...@@ -202,58 +202,36 @@
title: CamemBERT title: CamemBERT
- local: model_doc/canine - local: model_doc/canine
title: CANINE title: CANINE
- local: model_doc/clip
title: CLIP
- local: model_doc/codegen - local: model_doc/codegen
title: CodeGen title: CodeGen
- local: model_doc/convbert - local: model_doc/convbert
title: ConvBERT title: ConvBERT
- local: model_doc/convnext
title: ConvNeXT
- local: model_doc/cpm - local: model_doc/cpm
title: CPM title: CPM
- local: model_doc/ctrl - local: model_doc/ctrl
title: CTRL title: CTRL
- local: model_doc/cvt
title: CvT
- local: model_doc/data2vec
title: Data2Vec
- local: model_doc/deberta - local: model_doc/deberta
title: DeBERTa title: DeBERTa
- local: model_doc/deberta-v2 - local: model_doc/deberta-v2
title: DeBERTa-v2 title: DeBERTa-v2
- local: model_doc/decision_transformer
title: Decision Transformer
- local: model_doc/deit
title: DeiT
- local: model_doc/detr
title: DETR
- local: model_doc/dialogpt - local: model_doc/dialogpt
title: DialoGPT title: DialoGPT
- local: model_doc/distilbert - local: model_doc/distilbert
title: DistilBERT title: DistilBERT
- local: model_doc/dit
title: DiT
- local: model_doc/dpr - local: model_doc/dpr
title: DPR title: DPR
- local: model_doc/dpt
title: DPT
- local: model_doc/electra - local: model_doc/electra
title: ELECTRA title: ELECTRA
- local: model_doc/encoder-decoder - local: model_doc/encoder-decoder
title: Encoder Decoder Models title: Encoder Decoder Models
- local: model_doc/flaubert - local: model_doc/flaubert
title: FlauBERT title: FlauBERT
- local: model_doc/flava
title: FLAVA
- local: model_doc/fnet - local: model_doc/fnet
title: FNet title: FNet
- local: model_doc/fsmt - local: model_doc/fsmt
title: FSMT title: FSMT
- local: model_doc/funnel - local: model_doc/funnel
title: Funnel Transformer title: Funnel Transformer
- local: model_doc/glpn
title: GLPN
- local: model_doc/openai-gpt - local: model_doc/openai-gpt
title: GPT title: GPT
- local: model_doc/gpt_neo - local: model_doc/gpt_neo
...@@ -264,28 +242,14 @@ ...@@ -264,28 +242,14 @@
title: GPT-J title: GPT-J
- local: model_doc/gpt2 - local: model_doc/gpt2
title: GPT2 title: GPT2
- local: model_doc/groupvit
title: GroupViT
- local: model_doc/herbert - local: model_doc/herbert
title: HerBERT title: HerBERT
- local: model_doc/hubert
title: Hubert
- local: model_doc/ibert - local: model_doc/ibert
title: I-BERT title: I-BERT
- local: model_doc/imagegpt
title: ImageGPT
- local: model_doc/layoutlm - local: model_doc/layoutlm
title: LayoutLM title: LayoutLM
- local: model_doc/layoutlmv2
title: LayoutLMV2
- local: model_doc/layoutlmv3
title: LayoutLMV3
- local: model_doc/layoutxlm
title: LayoutXLM
- local: model_doc/led - local: model_doc/led
title: LED title: LED
- local: model_doc/levit
title: LeViT
- local: model_doc/longformer - local: model_doc/longformer
title: Longformer title: Longformer
- local: model_doc/longt5 - local: model_doc/longt5
...@@ -298,12 +262,8 @@ ...@@ -298,12 +262,8 @@
title: M2M100 title: M2M100
- local: model_doc/marian - local: model_doc/marian
title: MarianMT title: MarianMT
- local: model_doc/maskformer
title: MaskFormer
- local: model_doc/mbart - local: model_doc/mbart
title: MBart and MBart-50 title: MBart and MBart-50
- local: model_doc/mctct
title: MCTCT
- local: model_doc/megatron-bert - local: model_doc/megatron-bert
title: MegatronBERT title: MegatronBERT
- local: model_doc/megatron_gpt2 - local: model_doc/megatron_gpt2
...@@ -312,8 +272,6 @@ ...@@ -312,8 +272,6 @@
title: mLUKE title: mLUKE
- local: model_doc/mobilebert - local: model_doc/mobilebert
title: MobileBERT title: MobileBERT
- local: model_doc/mobilevit
title: MobileViT
- local: model_doc/mpnet - local: model_doc/mpnet
title: MPNet title: MPNet
- local: model_doc/mt5 - local: model_doc/mt5
...@@ -328,18 +286,12 @@ ...@@ -328,18 +286,12 @@
title: Nyströmformer title: Nyströmformer
- local: model_doc/opt - local: model_doc/opt
title: OPT title: OPT
- local: model_doc/owlvit
title: OWL-ViT
- local: model_doc/pegasus - local: model_doc/pegasus
title: Pegasus title: Pegasus
- local: model_doc/perceiver
title: Perceiver
- local: model_doc/phobert - local: model_doc/phobert
title: PhoBERT title: PhoBERT
- local: model_doc/plbart - local: model_doc/plbart
title: PLBart title: PLBart
- local: model_doc/poolformer
title: PoolFormer
- local: model_doc/prophetnet - local: model_doc/prophetnet
title: ProphetNet title: ProphetNet
- local: model_doc/qdqbert - local: model_doc/qdqbert
...@@ -350,38 +302,18 @@ ...@@ -350,38 +302,18 @@
title: REALM title: REALM
- local: model_doc/reformer - local: model_doc/reformer
title: Reformer title: Reformer
- local: model_doc/regnet
title: RegNet
- local: model_doc/rembert - local: model_doc/rembert
title: RemBERT title: RemBERT
- local: model_doc/resnet
title: ResNet
- local: model_doc/retribert - local: model_doc/retribert
title: RetriBERT title: RetriBERT
- local: model_doc/roberta - local: model_doc/roberta
title: RoBERTa title: RoBERTa
- local: model_doc/roformer - local: model_doc/roformer
title: RoFormer title: RoFormer
- local: model_doc/segformer
title: SegFormer
- local: model_doc/sew
title: SEW
- local: model_doc/sew-d
title: SEW-D
- local: model_doc/speech-encoder-decoder
title: Speech Encoder Decoder Models
- local: model_doc/speech_to_text
title: Speech2Text
- local: model_doc/speech_to_text_2
title: Speech2Text2
- local: model_doc/splinter - local: model_doc/splinter
title: Splinter title: Splinter
- local: model_doc/squeezebert - local: model_doc/squeezebert
title: SqueezeBERT title: SqueezeBERT
- local: model_doc/swin
title: Swin Transformer
- local: model_doc/swinv2
title: Swin Transformer V2
- local: model_doc/t5 - local: model_doc/t5
title: T5 title: T5
- local: model_doc/t5v1.1 - local: model_doc/t5v1.1
...@@ -390,32 +322,94 @@ ...@@ -390,32 +322,94 @@
title: TAPAS title: TAPAS
- local: model_doc/tapex - local: model_doc/tapex
title: TAPEX title: TAPEX
- local: model_doc/trajectory_transformer
title: Trajectory Transformer
- local: model_doc/transfo-xl - local: model_doc/transfo-xl
title: Transformer XL title: Transformer XL
- local: model_doc/trocr
title: TrOCR
- local: model_doc/ul2 - local: model_doc/ul2
title: UL2 title: UL2
- local: model_doc/unispeech - local: model_doc/xglm
title: UniSpeech title: XGLM
- local: model_doc/unispeech-sat - local: model_doc/xlm
title: UniSpeech-SAT title: XLM
- local: model_doc/xlm-prophetnet
title: XLM-ProphetNet
- local: model_doc/xlm-roberta
title: XLM-RoBERTa
- local: model_doc/xlm-roberta-xl
title: XLM-RoBERTa-XL
- local: model_doc/xlnet
title: XLNet
- local: model_doc/yoso
title: YOSO
title: Text models
- isExpanded: false
sections:
- local: model_doc/beit
title: BEiT
- local: model_doc/convnext
title: ConvNeXT
- local: model_doc/cvt
title: CvT
- local: model_doc/deit
title: DeiT
- local: model_doc/detr
title: DETR
- local: model_doc/dit
title: DiT
- local: model_doc/dpt
title: DPT
- local: model_doc/glpn
title: GLPN
- local: model_doc/groupvit
title: GroupViT
- local: model_doc/imagegpt
title: ImageGPT
- local: model_doc/levit
title: LeViT
- local: model_doc/maskformer
title: MaskFormer
- local: model_doc/mobilevit
title: MobileViT
- local: model_doc/owlvit
title: OWL-ViT
- local: model_doc/poolformer
title: PoolFormer
- local: model_doc/regnet
title: RegNet
- local: model_doc/resnet
title: ResNet
- local: model_doc/segformer
title: SegFormer
- local: model_doc/swin
title: Swin Transformer
- local: model_doc/swinv2
title: Swin Transformer V2
- local: model_doc/van - local: model_doc/van
title: VAN title: VAN
- local: model_doc/vilt
title: ViLT
- local: model_doc/vision-encoder-decoder
title: Vision Encoder Decoder Models
- local: model_doc/vision-text-dual-encoder
title: Vision Text Dual Encoder
- local: model_doc/vit - local: model_doc/vit
title: Vision Transformer (ViT) title: Vision Transformer (ViT)
- local: model_doc/visual_bert
title: VisualBERT
- local: model_doc/vit_mae - local: model_doc/vit_mae
title: ViTMAE title: ViTMAE
- local: model_doc/yolos
title: YOLOS
title: Vision models
- isExpanded: false
sections:
- local: model_doc/hubert
title: Hubert
- local: model_doc/mctct
title: MCTCT
- local: model_doc/sew
title: SEW
- local: model_doc/sew-d
title: SEW-D
- local: model_doc/speech_to_text
title: Speech2Text
- local: model_doc/speech_to_text_2
title: Speech2Text2
- local: model_doc/unispeech
title: UniSpeech
- local: model_doc/unispeech-sat
title: UniSpeech-SAT
- local: model_doc/wav2vec2 - local: model_doc/wav2vec2
title: Wav2Vec2 title: Wav2Vec2
- local: model_doc/wav2vec2-conformer - local: model_doc/wav2vec2-conformer
...@@ -424,26 +418,47 @@ ...@@ -424,26 +418,47 @@
title: Wav2Vec2Phoneme title: Wav2Vec2Phoneme
- local: model_doc/wavlm - local: model_doc/wavlm
title: WavLM title: WavLM
- local: model_doc/xglm
title: XGLM
- local: model_doc/xlm
title: XLM
- local: model_doc/xlm-prophetnet
title: XLM-ProphetNet
- local: model_doc/xlm-roberta
title: XLM-RoBERTa
- local: model_doc/xlm-roberta-xl
title: XLM-RoBERTa-XL
- local: model_doc/xlnet
title: XLNet
- local: model_doc/xls_r - local: model_doc/xls_r
title: XLS-R title: XLS-R
- local: model_doc/xlsr_wav2vec2 - local: model_doc/xlsr_wav2vec2
title: XLSR-Wav2Vec2 title: XLSR-Wav2Vec2
- local: model_doc/yolos title: Audio models
title: YOLOS - isExpanded: false
- local: model_doc/yoso sections:
title: YOSO - local: model_doc/clip
title: CLIP
- local: model_doc/data2vec
title: Data2Vec
- local: model_doc/flava
title: FLAVA
- local: model_doc/layoutlmv2
title: LayoutLMV2
- local: model_doc/layoutlmv3
title: LayoutLMV3
- local: model_doc/layoutxlm
title: LayoutXLM
- local: model_doc/perceiver
title: Perceiver
- local: model_doc/speech-encoder-decoder
title: Speech Encoder Decoder Models
- local: model_doc/trocr
title: TrOCR
- local: model_doc/vilt
title: ViLT
- local: model_doc/vision-encoder-decoder
title: Vision Encoder Decoder Models
- local: model_doc/vision-text-dual-encoder
title: Vision Text Dual Encoder
- local: model_doc/visual_bert
title: VisualBERT
title: Multimodal models
- isExpanded: false
sections:
- local: model_doc/decision_transformer
title: Decision Transformer
- local: model_doc/trajectory_transformer
title: Trajectory Transformer
title: Reinforcement learning models
title: Models title: Models
- sections: - sections:
- local: internal/modeling_utils - local: internal/modeling_utils
......
utils/check_doc_toc.py
View file @ 151a2aaa
...@@ -65,12 +65,22 @@ def check_model_doc(overwrite=False): ...@@ -65,12 +65,22 @@ def check_model_doc(overwrite=False):
while api_doc[model_idx]["title"] != "Models": while api_doc[model_idx]["title"] != "Models":
model_idx += 1 model_idx += 1
old_model_doc = api_doc[model_idx]["sections"] model_doc = api_doc[model_idx]["sections"]
new_model_doc = clean_model_doc_toc(old_model_doc)
if old_model_doc != new_model_doc: modalities_docs = [(idx, section) for idx, section in enumerate(model_doc) if "sections" in section]
diff = False
for idx, modality_doc in modalities_docs:
old_modality_doc = modality_doc["sections"]
new_modality_doc = clean_model_doc_toc(old_modality_doc)
if old_modality_doc != new_modality_doc:
diff = True
if overwrite:
model_doc[idx]["sections"] = new_modality_doc
if diff:
if overwrite: if overwrite:
api_doc[model_idx]["sections"] = new_model_doc api_doc[model_idx]["sections"] = model_doc
content[api_idx]["sections"] = api_doc content[api_idx]["sections"] = api_doc
with open(PATH_TO_TOC, "w", encoding="utf-8") as f: with open(PATH_TO_TOC, "w", encoding="utf-8") as f:
f.write(yaml.dump(content, allow_unicode=True)) f.write(yaml.dump(content, allow_unicode=True))
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment