_toctree.yml 18.4 KB
Newer Older
1
- sections:
Sylvain Gugger's avatar
Sylvain Gugger committed
2
3
4
5
6
7
8
9
  - local: index
    title: 🤗 Transformers
  - local: quicktour
    title: Quick tour
  - local: installation
    title: Installation
  title: Get started
- sections:
Steven Liu's avatar
Steven Liu committed
10
11
12
13
14
15
  - local: pipeline_tutorial
    title: Pipelines for inference
  - local: autoclass_tutorial
    title: Load pretrained instances with an AutoClass
  - local: preprocessing
    title: Preprocess
Sylvain Gugger's avatar
Sylvain Gugger committed
16
  - local: training
17
    title: Fine-tune a pretrained model
18
19
  - local: accelerate
    title: Distributed training with 🤗 Accelerate
Sylvain Gugger's avatar
Sylvain Gugger committed
20
  - local: model_sharing
21
    title: Share a model
Steven Liu's avatar
Steven Liu committed
22
  title: Tutorials
Sylvain Gugger's avatar
Sylvain Gugger committed
23
- sections:
Steven Liu's avatar
Steven Liu committed
24
  - sections:
Steven Liu's avatar
Steven Liu committed
25
26
27
28
29
30
31
32
33
    - local: create_a_model
      title: Create a custom architecture
    - local: custom_models
      title: Sharing custom models
    - local: run_scripts
      title: Train with a script
    - local: sagemaker
      title: Run training on Amazon SageMaker
    - local: converting_tensorflow_models
34
      title: Converting from TensorFlow checkpoints
Steven Liu's avatar
Steven Liu committed
35
    - local: serialization
Steven Liu's avatar
Steven Liu committed
36
37
38
      title: Export to ONNX
    - local: torchscript
      title: Export to TorchScript
Steven Liu's avatar
Steven Liu committed
39
40
41
42
43
44
45
46
    - local: troubleshooting
      title: Troubleshoot
    title: General usage
  - sections:
    - local: fast_tokenizers
      title: Use tokenizers from 🤗 Tokenizers
    - local: multilingual
      title: Inference for multilingual models
47
48
    - local: generation_strategies
      title: Text generation strategies
Steven Liu's avatar
Steven Liu committed
49
50
51
52
53
54
55
56
    - sections:
      - local: tasks/sequence_classification
        title: Text classification
      - local: tasks/token_classification
        title: Token classification
      - local: tasks/question_answering
        title: Question answering
      - local: tasks/language_modeling
57
58
59
        title: Causal language modeling
      - local: tasks/masked_language_modeling
        title: Masked language modeling
Steven Liu's avatar
Steven Liu committed
60
61
62
63
64
65
66
67
68
69
      - local: tasks/translation
        title: Translation
      - local: tasks/summarization
        title: Summarization
      - local: tasks/multiple_choice
        title: Multiple choice
      title: Task guides
      isExpanded: false
    title: Natural Language Processing
  - sections:
Steven Liu's avatar
Steven Liu committed
70
71
72
73
    - local: tasks/audio_classification
      title: Audio classification
    - local: tasks/asr
      title: Automatic speech recognition
Steven Liu's avatar
Steven Liu committed
74
75
    title: Audio
  - sections:
Steven Liu's avatar
Steven Liu committed
76
77
    - local: tasks/image_classification
      title: Image classification
78
79
    - local: tasks/semantic_segmentation
      title: Semantic segmentation
80
81
    - local: tasks/video_classification
      title: Video classification
82
83
    - local: tasks/object_detection
      title: Object detection
Steven Liu's avatar
Steven Liu committed
84
    title: Computer Vision
85
86
87
  - sections:
    - local: tasks/image_captioning
      title: Image captioning
88
89
    - local: tasks/document_question_answering
      title: Document Question Answering
90
    title: Multimodal
91
92
93
94
95
96
97
98
99
  - sections:
    - local: performance
      title: Overview
    - local: perf_train_gpu_one
      title: Training on one GPU
    - local: perf_train_gpu_many
      title: Training on many GPUs
    - local: perf_train_cpu
      title: Training on CPU
100
101
    - local: perf_train_cpu_many
      title: Training on many CPUs
102
103
    - local: perf_train_tpu
      title: Training on TPUs
Matt's avatar
Matt committed
104
105
    - local: perf_train_tpu_tf
      title: Training on TPU with TensorFlow
106
107
108
109
110
111
112
113
114
115
116
117
    - local: perf_train_special
      title: Training on Specialized Hardware
    - local: perf_infer_cpu
      title: Inference on CPU
    - local: perf_infer_gpu_one
      title: Inference on one GPU
    - local: perf_infer_gpu_many
      title: Inference on many GPUs
    - local: perf_infer_special
      title: Inference on Specialized Hardware
    - local: perf_hardware
      title: Custom hardware for training
Steven Liu's avatar
Steven Liu committed
118
119
120
121
    - local: big_models
      title: Instantiating a big model
    - local: debugging
      title: Debugging
122
123
    - local: hpo_train
      title: Hyperparameter Search using Trainer API
124
125
    - local: tf_xla
      title: XLA Integration for TensorFlow Models
126
    title: Performance and scalability
Steven Liu's avatar
Steven Liu committed
127
128
129
130
131
  - sections:
    - local: contributing
      title: How to contribute to transformers?
    - local: add_new_model
      title: How to add a model to 🤗 Transformers?
132
133
    - local: add_tensorflow_model
      title: How to convert a 🤗 Transformers model to TensorFlow?
Steven Liu's avatar
Steven Liu committed
134
135
136
137
138
139
140
141
142
143
144
    - local: add_new_pipeline
      title: How to add a pipeline to 🤗 Transformers?
    - local: testing
      title: Testing
    - local: pr_checks
      title: Checks on a Pull Request
    title: Contribute
  - local: notebooks
    title: 🤗 Transformers Notebooks
  - local: community
    title: Community resources
145
146
  - local: benchmarks
    title: Benchmarks
Sylvain Gugger's avatar
Sylvain Gugger committed
147
148
  - local: migration
    title: Migrating from previous packages
Steven Liu's avatar
Steven Liu committed
149
  title: How-to guides
Sylvain Gugger's avatar
Sylvain Gugger committed
150
- sections:
151
152
153
154
155
  - local: philosophy
    title: Philosophy
  - local: glossary
    title: Glossary
  - local: task_summary
156
    title: What 🤗 Transformers can do
Steven Liu's avatar
Steven Liu committed
157
158
  - local: tasks_explained
    title: How 🤗 Transformers solve tasks
159
  - local: model_summary
Steven Liu's avatar
Steven Liu committed
160
    title: The Transformer model family
161
162
  - local: tokenizer_summary
    title: Summary of the tokenizers
Steven Liu's avatar
Steven Liu committed
163
164
  - local: attention
    title: Attention mechanisms
165
166
  - local: pad_truncation
    title: Padding and truncation
Sylvain Gugger's avatar
Sylvain Gugger committed
167
168
169
170
  - local: bertology
    title: BERTology
  - local: perplexity
    title: Perplexity of fixed-length models
171
172
  - local: pipeline_webserver
    title: Pipelines for webserver inference
173
  title: Conceptual guides
Sylvain Gugger's avatar
Sylvain Gugger committed
174
175
- sections:
  - sections:
176
177
    - local: model_doc/auto
      title: Auto Classes
Sylvain Gugger's avatar
Sylvain Gugger committed
178
179
180
181
182
183
184
185
186
187
188
189
    - local: main_classes/callback
      title: Callbacks
    - local: main_classes/configuration
      title: Configuration
    - local: main_classes/data_collator
      title: Data Collator
    - local: main_classes/keras_callbacks
      title: Keras callbacks
    - local: main_classes/logging
      title: Logging
    - local: main_classes/model
      title: Models
190
191
    - local: main_classes/text_generation
      title: Text Generation
192
193
    - local: main_classes/onnx
      title: ONNX
Sylvain Gugger's avatar
Sylvain Gugger committed
194
195
196
197
198
199
200
201
    - local: main_classes/optimizer_schedules
      title: Optimization
    - local: main_classes/output
      title: Model outputs
    - local: main_classes/pipelines
      title: Pipelines
    - local: main_classes/processors
      title: Processors
202
203
    - local: main_classes/quantization
      title: Quantization
Sylvain Gugger's avatar
Sylvain Gugger committed
204
205
206
207
208
209
210
211
    - local: main_classes/tokenizer
      title: Tokenizer
    - local: main_classes/trainer
      title: Trainer
    - local: main_classes/deepspeed
      title: DeepSpeed Integration
    - local: main_classes/feature_extractor
      title: Feature Extractor
amyeroberts's avatar
amyeroberts committed
212
213
    - local: main_classes/image_processor
      title: Image Processor
Sylvain Gugger's avatar
Sylvain Gugger committed
214
215
    title: Main Classes
  - sections:
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
    - isExpanded: false
      sections:
      - local: model_doc/albert
        title: ALBERT
      - local: model_doc/bart
        title: BART
      - local: model_doc/barthez
        title: BARThez
      - local: model_doc/bartpho
        title: BARTpho
      - local: model_doc/bert
        title: BERT
      - local: model_doc/bert-generation
        title: BertGeneration
      - local: model_doc/bert-japanese
        title: BertJapanese
      - local: model_doc/bertweet
        title: Bertweet
      - local: model_doc/big_bird
        title: BigBird
      - local: model_doc/bigbird_pegasus
        title: BigBirdPegasus
Kamal Raj Kanakarajan's avatar
Kamal Raj Kanakarajan committed
238
239
      - local: model_doc/biogpt
        title: BioGpt
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
      - local: model_doc/blenderbot
        title: Blenderbot
      - local: model_doc/blenderbot-small
        title: Blenderbot Small
      - local: model_doc/bloom
        title: BLOOM
      - local: model_doc/bort
        title: BORT
      - local: model_doc/byt5
        title: ByT5
      - local: model_doc/camembert
        title: CamemBERT
      - local: model_doc/canine
        title: CANINE
      - local: model_doc/codegen
        title: CodeGen
      - local: model_doc/convbert
        title: ConvBERT
      - local: model_doc/cpm
        title: CPM
      - local: model_doc/ctrl
        title: CTRL
      - local: model_doc/deberta
        title: DeBERTa
      - local: model_doc/deberta-v2
        title: DeBERTa-v2
      - local: model_doc/dialogpt
        title: DialoGPT
      - local: model_doc/distilbert
        title: DistilBERT
      - local: model_doc/dpr
        title: DPR
      - local: model_doc/electra
        title: ELECTRA
      - local: model_doc/encoder-decoder
        title: Encoder Decoder Models
276
277
      - local: model_doc/ernie
        title: ERNIE
278
279
      - local: model_doc/ernie_m
        title: ErnieM
280
281
      - local: model_doc/esm
        title: ESM
282
283
      - local: model_doc/flan-t5
        title: FLAN-T5
284
285
286
287
288
289
290
291
292
293
294
295
296
297
      - local: model_doc/flaubert
        title: FlauBERT
      - local: model_doc/fnet
        title: FNet
      - local: model_doc/fsmt
        title: FSMT
      - local: model_doc/funnel
        title: Funnel Transformer
      - local: model_doc/openai-gpt
        title: GPT
      - local: model_doc/gpt_neo
        title: GPT Neo
      - local: model_doc/gpt_neox
        title: GPT NeoX
298
299
      - local: model_doc/gpt_neox_japanese
        title: GPT NeoX Japanese
300
301
302
303
      - local: model_doc/gptj
        title: GPT-J
      - local: model_doc/gpt2
        title: GPT2
304
305
      - local: model_doc/gpt-sw3
        title: GPTSw3
306
307
308
309
      - local: model_doc/herbert
        title: HerBERT
      - local: model_doc/ibert
        title: I-BERT
310
311
      - local: model_doc/jukebox
        title: Jukebox
312
313
314
315
316
317
318
319
320
321
322
323
      - local: model_doc/led
        title: LED
      - local: model_doc/longformer
        title: Longformer
      - local: model_doc/longt5
        title: LongT5
      - local: model_doc/luke
        title: LUKE
      - local: model_doc/m2m_100
        title: M2M100
      - local: model_doc/marian
        title: MarianMT
NielsRogge's avatar
NielsRogge committed
324
325
      - local: model_doc/markuplm
        title: MarkupLM
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
      - local: model_doc/mbart
        title: MBart and MBart-50
      - local: model_doc/megatron-bert
        title: MegatronBERT
      - local: model_doc/megatron_gpt2
        title: MegatronGPT2
      - local: model_doc/mluke
        title: mLUKE
      - local: model_doc/mobilebert
        title: MobileBERT
      - local: model_doc/mpnet
        title: MPNet
      - local: model_doc/mt5
        title: MT5
      - local: model_doc/mvp
        title: MVP
      - local: model_doc/nezha
        title: NEZHA
      - local: model_doc/nllb
        title: NLLB
      - local: model_doc/nystromformer
        title: Nyströmformer
      - local: model_doc/opt
        title: OPT
      - local: model_doc/pegasus
        title: Pegasus
Jason Phang's avatar
Jason Phang committed
352
353
      - local: model_doc/pegasus_x
        title: PEGASUS-X
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
      - local: model_doc/phobert
        title: PhoBERT
      - local: model_doc/plbart
        title: PLBart
      - local: model_doc/prophetnet
        title: ProphetNet
      - local: model_doc/qdqbert
        title: QDQBert
      - local: model_doc/rag
        title: RAG
      - local: model_doc/realm
        title: REALM
      - local: model_doc/reformer
        title: Reformer
      - local: model_doc/rembert
        title: RemBERT
      - local: model_doc/retribert
        title: RetriBERT
      - local: model_doc/roberta
        title: RoBERTa
374
375
      - local: model_doc/roberta-prelayernorm
        title: RoBERTa-PreLayerNorm
Weiwe Shi's avatar
Weiwe Shi committed
376
377
      - local: model_doc/roc_bert
        title: RoCBert
378
379
380
381
382
383
      - local: model_doc/roformer
        title: RoFormer
      - local: model_doc/splinter
        title: Splinter
      - local: model_doc/squeezebert
        title: SqueezeBERT
384
385
      - local: model_doc/switch_transformers
        title: SwitchTransformers
386
387
388
389
390
391
392
393
394
395
      - local: model_doc/t5
        title: T5
      - local: model_doc/t5v1.1
        title: T5v1.1
      - local: model_doc/tapex
        title: TAPEX
      - local: model_doc/transfo-xl
        title: Transformer XL
      - local: model_doc/ul2
        title: UL2
Jannis Vamvas's avatar
Jannis Vamvas committed
396
397
      - local: model_doc/xmod
        title: X-MOD
398
399
400
401
402
403
404
405
406
407
      - 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
408
409
      - local: model_doc/xlm-v
        title: XLM-V
410
411
412
413
414
415
416
417
418
      - local: model_doc/xlnet
        title: XLNet
      - local: model_doc/yoso
        title: YOSO
      title: Text models
    - isExpanded: false
      sections:
      - local: model_doc/beit
        title: BEiT
NielsRogge's avatar
NielsRogge committed
419
420
      - local: model_doc/bit
        title: BiT
421
422
      - local: model_doc/conditional_detr
        title: Conditional DETR
423
424
425
426
      - local: model_doc/convnext
        title: ConvNeXT
      - local: model_doc/cvt
        title: CvT
NielsRogge's avatar
NielsRogge committed
427
428
      - local: model_doc/deformable_detr
        title: Deformable DETR
429
430
      - local: model_doc/deit
        title: DeiT
NielsRogge's avatar
NielsRogge committed
431
432
      - local: model_doc/deta
        title: DETA
433
434
      - local: model_doc/detr
        title: DETR
435
436
      - local: model_doc/dinat
        title: DiNAT
437
438
439
440
      - local: model_doc/dit
        title: DiT
      - local: model_doc/dpt
        title: DPT
441
442
      - local: model_doc/efficientformer
        title: EfficientFormer
443
444
445
446
447
448
      - local: model_doc/glpn
        title: GLPN
      - local: model_doc/imagegpt
        title: ImageGPT
      - local: model_doc/levit
        title: LeViT
Alara Dirik's avatar
Alara Dirik committed
449
450
      - local: model_doc/mask2former
        title: Mask2Former
451
452
      - local: model_doc/maskformer
        title: MaskFormer
453
454
      - local: model_doc/mobilenet_v1
        title: MobileNetV1
455
456
      - local: model_doc/mobilenet_v2
        title: MobileNetV2
457
458
      - local: model_doc/mobilevit
        title: MobileViT
459
460
      - local: model_doc/nat
        title: NAT
461
462
463
464
465
466
467
468
469
470
471
472
      - 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
NielsRogge's avatar
NielsRogge committed
473
474
      - local: model_doc/swin2sr
        title: Swin2SR
475
476
      - local: model_doc/table-transformer
        title: Table Transformer
477
478
      - local: model_doc/timesformer
        title: TimeSformer
NielsRogge's avatar
NielsRogge committed
479
480
      - local: model_doc/upernet
        title: UperNet
481
482
      - local: model_doc/van
        title: VAN
NielsRogge's avatar
NielsRogge committed
483
484
      - local: model_doc/videomae
        title: VideoMAE
485
486
      - local: model_doc/vit
        title: Vision Transformer (ViT)
NielsRogge's avatar
NielsRogge committed
487
488
      - local: model_doc/vit_hybrid
        title: ViT Hybrid
489
490
      - local: model_doc/vit_mae
        title: ViTMAE
491
492
      - local: model_doc/vit_msn
        title: ViTMSN
493
494
495
496
497
      - local: model_doc/yolos
        title: YOLOS
      title: Vision models
    - isExpanded: false
      sections:
498
499
      - local: model_doc/audio-spectrogram-transformer
        title: Audio Spectrogram Transformer
500
501
      - local: model_doc/clap
        title: CLAP
502
503
504
505
506
507
508
509
510
511
512
513
      - 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
514
515
      - local: model_doc/speecht5
        title: SpeechT5
516
517
518
519
520
521
522
523
524
525
526
527
      - local: model_doc/unispeech
        title: UniSpeech
      - local: model_doc/unispeech-sat
        title: UniSpeech-SAT
      - local: model_doc/wav2vec2
        title: Wav2Vec2
      - local: model_doc/wav2vec2-conformer
        title: Wav2Vec2-Conformer
      - local: model_doc/wav2vec2_phoneme
        title: Wav2Vec2Phoneme
      - local: model_doc/wavlm
        title: WavLM
528
529
      - local: model_doc/whisper
        title: Whisper
530
531
532
533
534
535
536
      - local: model_doc/xls_r
        title: XLS-R
      - local: model_doc/xlsr_wav2vec2
        title: XLSR-Wav2Vec2
      title: Audio models
    - isExpanded: false
      sections:
Jongjyh's avatar
Jongjyh committed
537
538
      - local: model_doc/altclip
        title: AltCLIP
Younes Belkada's avatar
Younes Belkada committed
539
540
      - local: model_doc/blip
        title: BLIP
NielsRogge's avatar
NielsRogge committed
541
542
      - local: model_doc/blip-2
        title: BLIP-2
543
544
      - local: model_doc/bridgetower
        title: BridgeTower
545
546
      - local: model_doc/chinese_clip
        title: Chinese-CLIP
547
548
      - local: model_doc/clip
        title: CLIP
NielsRogge's avatar
NielsRogge committed
549
550
      - local: model_doc/clipseg
        title: CLIPSeg
551
552
      - local: model_doc/data2vec
        title: Data2Vec
NielsRogge's avatar
NielsRogge committed
553
554
      - local: model_doc/donut
        title: Donut
555
556
      - local: model_doc/flava
        title: FLAVA
557
558
      - local: model_doc/git
        title: GIT
Steven Liu's avatar
Steven Liu committed
559
560
      - local: model_doc/groupvit
        title: GroupViT
NielsRogge's avatar
NielsRogge committed
561
562
      - local: model_doc/layoutlm
        title: LayoutLM
563
564
565
566
567
568
      - local: model_doc/layoutlmv2
        title: LayoutLMV2
      - local: model_doc/layoutlmv3
        title: LayoutLMV3
      - local: model_doc/layoutxlm
        title: LayoutXLM
569
570
      - local: model_doc/lilt
        title: LiLT
Steven Liu's avatar
Steven Liu committed
571
572
      - local: model_doc/lxmert
        title: LXMERT
Jitesh Jain's avatar
Jitesh Jain committed
573
574
      - local: model_doc/oneformer
        title: OneFormer
575
576
      - local: model_doc/owlvit
        title: OWL-ViT
577
578
579
580
      - local: model_doc/perceiver
        title: Perceiver
      - local: model_doc/speech-encoder-decoder
        title: Speech Encoder Decoder Models
NielsRogge's avatar
NielsRogge committed
581
582
      - local: model_doc/tapas
        title: TAPAS
583
584
      - local: model_doc/trocr
        title: TrOCR
Zineng Tang's avatar
Zineng Tang committed
585
586
      - local: model_doc/tvlt
        title: TVLT
587
588
589
590
591
592
593
594
      - 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
NielsRogge's avatar
NielsRogge committed
595
596
      - local: model_doc/xclip
        title: X-CLIP
597
598
599
600
601
602
603
604
      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
605
606
607
608
609
    - isExpanded: false
      sections:
      - local: model_doc/time_series_transformer
        title: Time Series Transformer
      title: Time series models
610
611
612
613
614
    - isExpanded: false
      sections:
      - local: model_doc/graphormer
        title: Graphormer
      title: Graph models
Sylvain Gugger's avatar
Sylvain Gugger committed
615
616
617
618
619
620
621
622
623
624
625
626
    title: Models
  - sections:
    - local: internal/modeling_utils
      title: Custom Layers and Utilities
    - local: internal/pipelines_utils
      title: Utilities for pipelines
    - local: internal/tokenization_utils
      title: Utilities for Tokenizers
    - local: internal/trainer_utils
      title: Utilities for Trainer
    - local: internal/generation_utils
      title: Utilities for Generation
627
628
    - local: internal/image_processing_utils
      title: Utilities for Image Processors
629
630
    - local: internal/audio_utils
      title: Utilities for Audio processing
Sylvain Gugger's avatar
Sylvain Gugger committed
631
632
633
    - local: internal/file_utils
      title: General Utilities
    title: Internal Helpers
634
  title: API