_toctree.yml 11.8 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:
24
25
  - local: fast_tokenizers
    title: "Use tokenizers from 馃 Tokenizers"
26
  - local: create_a_model
27
28
29
    title: Create a custom architecture
  - local: custom_models
    title: Sharing custom models
Steven Liu's avatar
Steven Liu committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
  - 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
      title: Language modeling
    - local: tasks/translation
      title: Translation
    - local: tasks/summarization
      title: Summarization
    - local: tasks/multiple_choice
      title: Multiple choice
Steven Liu's avatar
Steven Liu committed
45
46
47
48
49
50
    - local: tasks/audio_classification
      title: Audio classification
    - local: tasks/asr
      title: Automatic speech recognition
    - local: tasks/image_classification
      title: Image classification
Steven Liu's avatar
Steven Liu committed
51
    title: Fine-tune for downstream tasks
52
53
  - local: run_scripts
    title: Train with a script
Sylvain Gugger's avatar
Sylvain Gugger committed
54
55
  - local: sagemaker
    title: Run training on Amazon SageMaker
56
57
  - local: multilingual
    title: Inference for multilingual models
Sylvain Gugger's avatar
Sylvain Gugger committed
58
  - local: converting_tensorflow_models
59
60
61
62
    title: Converting TensorFlow Checkpoints
  - local: serialization
    title: Export 馃 Transformers models
  - local: performance
63
    title: Performance and scalability
64
65
  - local: big_models
    title: Instantiating a big model
66
67
  - local: benchmarks
    title: Benchmarks
Sylvain Gugger's avatar
Sylvain Gugger committed
68
69
  - local: migration
    title: Migrating from previous packages
70
71
72
73
74
75
76
77
  - local: troubleshooting
    title: Troubleshoot
  - local: debugging
    title: Debugging
  - local: notebooks
    title: "馃 Transformers Notebooks"
  - local: community
    title: Community
Sylvain Gugger's avatar
Sylvain Gugger committed
78
79
80
81
82
83
  - local: contributing
    title: How to contribute to transformers?
  - local: add_new_model
    title: "How to add a model to 馃 Transformers?"
  - local: add_new_pipeline
    title: "How to add a pipeline to 馃 Transformers?"
84
85
86
87
  - local: perf_train_gpu_one
    title: Training on one GPU
  - local: perf_train_gpu_many
    title: Training on many GPUs
88
89
  - local: perf_train_cpu
    title: Training on CPU
90
91
  - local: perf_infer_cpu
    title: Inference on CPU
92
93
  - local: perf_hardware
    title: Custom hardware for training
Sylvain Gugger's avatar
Sylvain Gugger committed
94
95
  - local: testing
    title: Testing
96
97
  - local: pr_checks
    title: Checks on a Pull Request
Steven Liu's avatar
Steven Liu committed
98
  title: How-to guides
Sylvain Gugger's avatar
Sylvain Gugger committed
99
- sections:
100
101
102
103
104
105
106
107
108
109
110
111
  - local: philosophy
    title: Philosophy
  - local: glossary
    title: Glossary
  - local: task_summary
    title: Summary of the tasks
  - local: model_summary
    title: Summary of the models
  - local: tokenizer_summary
    title: Summary of the tokenizers
  - local: pad_truncation
    title: Padding and truncation
Sylvain Gugger's avatar
Sylvain Gugger committed
112
113
114
115
  - local: bertology
    title: BERTology
  - local: perplexity
    title: Perplexity of fixed-length models
116
  title: Conceptual guides
Sylvain Gugger's avatar
Sylvain Gugger committed
117
118
119
120
121
122
123
124
125
126
127
128
129
130
- sections:
  - sections:
    - 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
131
132
    - local: main_classes/text_generation
      title: Text Generation
133
134
    - local: main_classes/onnx
      title: ONNX
Sylvain Gugger's avatar
Sylvain Gugger committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
    - 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
    - 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
    title: Main Classes
  - sections:
    - local: model_doc/albert
      title: ALBERT
    - local: model_doc/auto
      title: Auto Classes
    - local: model_doc/bart
      title: BART
    - local: model_doc/barthez
      title: BARThez
    - local: model_doc/bartpho
      title: BARTpho
    - local: model_doc/beit
      title: BEiT
    - local: model_doc/bert
      title: BERT
    - local: model_doc/bertweet
      title: Bertweet
169
    - local: model_doc/bert-generation
Sylvain Gugger's avatar
Sylvain Gugger committed
170
      title: BertGeneration
171
    - local: model_doc/bert-japanese
Sylvain Gugger's avatar
Sylvain Gugger committed
172
      title: BertJapanese
173
    - local: model_doc/big_bird
Sylvain Gugger's avatar
Sylvain Gugger committed
174
175
176
177
178
      title: BigBird
    - local: model_doc/bigbird_pegasus
      title: BigBirdPegasus
    - local: model_doc/blenderbot
      title: Blenderbot
179
    - local: model_doc/blenderbot-small
Sylvain Gugger's avatar
Sylvain Gugger committed
180
      title: Blenderbot Small
Younes Belkada's avatar
Younes Belkada committed
181
182
    - local: model_doc/bloom
      title: BLOOM
Sylvain Gugger's avatar
Sylvain Gugger committed
183
184
185
186
187
188
189
190
    - local: model_doc/bort
      title: BORT
    - local: model_doc/byt5
      title: ByT5
    - local: model_doc/camembert
      title: CamemBERT
    - local: model_doc/canine
      title: CANINE
NielsRogge's avatar
NielsRogge committed
191
192
    - local: model_doc/convnext
      title: ConvNeXT
Sylvain Gugger's avatar
Sylvain Gugger committed
193
194
195
196
197
198
199
200
    - local: model_doc/clip
      title: CLIP
    - local: model_doc/convbert
      title: ConvBERT
    - local: model_doc/cpm
      title: CPM
    - local: model_doc/ctrl
      title: CTRL
NielsRogge's avatar
NielsRogge committed
201
202
    - local: model_doc/cvt
      title: CvT
203
204
    - local: model_doc/data2vec
      title: Data2Vec
Sylvain Gugger's avatar
Sylvain Gugger committed
205
206
    - local: model_doc/deberta
      title: DeBERTa
207
    - local: model_doc/deberta-v2
Sylvain Gugger's avatar
Sylvain Gugger committed
208
      title: DeBERTa-v2
209
210
    - local: model_doc/decision_transformer
      title: Decision Transformer
Sylvain Gugger's avatar
Sylvain Gugger committed
211
212
213
214
215
216
217
218
    - local: model_doc/deit
      title: DeiT
    - local: model_doc/detr
      title: DETR
    - local: model_doc/dialogpt
      title: DialoGPT
    - local: model_doc/distilbert
      title: DistilBERT
219
220
    - local: model_doc/dit
      title: DiT
Sylvain Gugger's avatar
Sylvain Gugger committed
221
222
    - local: model_doc/dpr
      title: DPR
NielsRogge's avatar
NielsRogge committed
223
224
    - local: model_doc/dpt
      title: DPT
Sylvain Gugger's avatar
Sylvain Gugger committed
225
226
    - local: model_doc/electra
      title: ELECTRA
227
    - local: model_doc/encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
228
229
230
      title: Encoder Decoder Models
    - local: model_doc/flaubert
      title: FlauBERT
231
232
    - local: model_doc/flava
      title: FLAVA
Sylvain Gugger's avatar
Sylvain Gugger committed
233
    - local: model_doc/fnet
234
      title: FNet
Sylvain Gugger's avatar
Sylvain Gugger committed
235
236
237
238
    - local: model_doc/fsmt
      title: FSMT
    - local: model_doc/funnel
      title: Funnel Transformer
NielsRogge's avatar
NielsRogge committed
239
240
    - local: model_doc/glpn
      title: GLPN
Sylvain Gugger's avatar
Sylvain Gugger committed
241
    - local: model_doc/herbert
242
      title: HerBERT
Sylvain Gugger's avatar
Sylvain Gugger committed
243
244
245
246
247
248
249
250
    - local: model_doc/ibert
      title: I-BERT
    - local: model_doc/imagegpt
      title: ImageGPT
    - local: model_doc/layoutlm
      title: LayoutLM
    - local: model_doc/layoutlmv2
      title: LayoutLMV2
NielsRogge's avatar
NielsRogge committed
251
252
    - local: model_doc/layoutlmv3
      title: LayoutLMV3
Sylvain Gugger's avatar
Sylvain Gugger committed
253
254
255
256
    - local: model_doc/layoutxlm
      title: LayoutXLM
    - local: model_doc/led
      title: LED
257
258
    - local: model_doc/levit
      title: LeViT
Sylvain Gugger's avatar
Sylvain Gugger committed
259
260
    - local: model_doc/longformer
      title: Longformer
Daniel Stancl's avatar
Daniel Stancl committed
261
262
    - local: model_doc/longt5
      title: LongT5
Sylvain Gugger's avatar
Sylvain Gugger committed
263
264
265
266
267
268
    - local: model_doc/luke
      title: LUKE
    - local: model_doc/lxmert
      title: LXMERT
    - local: model_doc/marian
      title: MarianMT
269
270
    - local: model_doc/maskformer
      title: MaskFormer
Sylvain Gugger's avatar
Sylvain Gugger committed
271
272
273
274
    - local: model_doc/m2m_100
      title: M2M100
    - local: model_doc/mbart
      title: MBart and MBart-50
Chan Woo Kim's avatar
Chan Woo Kim committed
275
276
    - local: model_doc/mctct
      title: MCTCT
277
    - local: model_doc/megatron-bert
Sylvain Gugger's avatar
Sylvain Gugger committed
278
279
280
      title: MegatronBERT
    - local: model_doc/megatron_gpt2
      title: MegatronGPT2
281
    - local: model_doc/mluke
Steven Liu's avatar
Steven Liu committed
282
      title: mLUKE
Sylvain Gugger's avatar
Sylvain Gugger committed
283
284
285
286
287
288
    - local: model_doc/mobilebert
      title: MobileBERT
    - local: model_doc/mpnet
      title: MPNet
    - local: model_doc/mt5
      title: MT5
novice's avatar
novice committed
289
290
    - local: model_doc/nystromformer
      title: Nystr枚mformer
291
    - local: model_doc/openai-gpt
Sylvain Gugger's avatar
Sylvain Gugger committed
292
      title: OpenAI GPT
Younes Belkada's avatar
Younes Belkada committed
293
294
    - local: model_doc/opt
      title: OPT
Sylvain Gugger's avatar
Sylvain Gugger committed
295
296
297
298
299
300
    - local: model_doc/gpt2
      title: OpenAI GPT2
    - local: model_doc/gptj
      title: GPT-J
    - local: model_doc/gpt_neo
      title: GPT Neo
301
302
    - local: model_doc/gpt_neox
      title: GPT NeoX
Sylvain Gugger's avatar
Sylvain Gugger committed
303
304
    - local: model_doc/hubert
      title: Hubert
305
306
    - local: model_doc/perceiver
      title: Perceiver
Sylvain Gugger's avatar
Sylvain Gugger committed
307
308
309
310
    - local: model_doc/pegasus
      title: Pegasus
    - local: model_doc/phobert
      title: PhoBERT
Gunjan Chhablani's avatar
Gunjan Chhablani committed
311
312
    - local: model_doc/plbart
      title: PLBart
Tanay Mehta's avatar
Tanay Mehta committed
313
314
    - local: model_doc/poolformer
      title: PoolFormer
Sylvain Gugger's avatar
Sylvain Gugger committed
315
316
317
318
319
320
    - local: model_doc/prophetnet
      title: ProphetNet
    - local: model_doc/qdqbert
      title: QDQBert
    - local: model_doc/rag
      title: RAG
Li-Huai (Allan) Lin's avatar
Li-Huai (Allan) Lin committed
321
322
    - local: model_doc/realm
      title: REALM
Sylvain Gugger's avatar
Sylvain Gugger committed
323
324
325
326
    - local: model_doc/reformer
      title: Reformer
    - local: model_doc/rembert
      title: RemBERT
Francesco Saverio Zuppichini's avatar
Francesco Saverio Zuppichini committed
327
328
    - local: model_doc/regnet
      title: RegNet
329
330
    - local: model_doc/resnet
      title: ResNet
Sylvain Gugger's avatar
Sylvain Gugger committed
331
332
333
334
335
336
337
338
339
340
    - local: model_doc/retribert
      title: RetriBERT
    - local: model_doc/roberta
      title: RoBERTa
    - local: model_doc/roformer
      title: RoFormer
    - local: model_doc/segformer
      title: SegFormer
    - local: model_doc/sew
      title: SEW
341
    - local: model_doc/sew-d
Sylvain Gugger's avatar
Sylvain Gugger committed
342
      title: SEW-D
343
    - local: model_doc/speech-encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
344
345
346
347
348
349
350
351
352
      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
      title: Splinter
    - local: model_doc/squeezebert
      title: SqueezeBERT
novice's avatar
novice committed
353
354
    - local: model_doc/swin
      title: Swin Transformer
Sylvain Gugger's avatar
Sylvain Gugger committed
355
356
357
358
359
360
    - local: model_doc/t5
      title: T5
    - local: model_doc/t5v1.1
      title: T5v1.1
    - local: model_doc/tapas
      title: TAPAS
NielsRogge's avatar
NielsRogge committed
361
362
    - local: model_doc/tapex
      title: TAPEX
Carl's avatar
Carl committed
363
364
    - local: model_doc/trajectory_transformer
      title: Trajectory Transformer
365
    - local: model_doc/transfo-xl
Sylvain Gugger's avatar
Sylvain Gugger committed
366
367
368
369
370
      title: Transformer XL
    - local: model_doc/trocr
      title: TrOCR
    - local: model_doc/unispeech
      title: UniSpeech
371
    - local: model_doc/unispeech-sat
Sylvain Gugger's avatar
Sylvain Gugger committed
372
      title: UniSpeech-SAT
373
374
    - local: model_doc/van
      title: VAN
NielsRogge's avatar
NielsRogge committed
375
376
    - local: model_doc/vilt
      title: ViLT
377
    - local: model_doc/vision-encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
378
      title: Vision Encoder Decoder Models
379
    - local: model_doc/vision-text-dual-encoder
380
      title: Vision Text Dual Encoder
Sylvain Gugger's avatar
Sylvain Gugger committed
381
382
    - local: model_doc/vit
      title: Vision Transformer (ViT)
NielsRogge's avatar
NielsRogge committed
383
384
    - local: model_doc/vit_mae
      title: ViTMAE
Sylvain Gugger's avatar
Sylvain Gugger committed
385
386
387
388
    - local: model_doc/visual_bert
      title: VisualBERT
    - local: model_doc/wav2vec2
      title: Wav2Vec2
389
390
    - local: model_doc/wav2vec2-conformer
      title: Wav2Vec2-Conformer
391
392
    - local: model_doc/wav2vec2_phoneme
      title: Wav2Vec2Phoneme
Patrick von Platen's avatar
Patrick von Platen committed
393
394
    - local: model_doc/wavlm
      title: WavLM
Suraj Patil's avatar
Suraj Patil committed
395
396
    - local: model_doc/xglm
      title: XGLM
Sylvain Gugger's avatar
Sylvain Gugger committed
397
398
    - local: model_doc/xlm
      title: XLM
399
    - local: model_doc/xlm-prophetnet
Sylvain Gugger's avatar
Sylvain Gugger committed
400
      title: XLM-ProphetNet
401
    - local: model_doc/xlm-roberta
Sylvain Gugger's avatar
Sylvain Gugger committed
402
      title: XLM-RoBERTa
403
404
    - local: model_doc/xlm-roberta-xl
      title: XLM-RoBERTa-XL
Sylvain Gugger's avatar
Sylvain Gugger committed
405
406
407
408
    - local: model_doc/xlnet
      title: XLNet
    - local: model_doc/xlsr_wav2vec2
      title: XLSR-Wav2Vec2
409
410
    - local: model_doc/xls_r
      title: XLS-R
NielsRogge's avatar
NielsRogge committed
411
412
    - local: model_doc/yolos
      title: YOLOS
novice's avatar
novice committed
413
414
    - local: model_doc/yoso
      title: YOSO
Sylvain Gugger's avatar
Sylvain Gugger committed
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
    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
    - local: internal/file_utils
      title: General Utilities
    title: Internal Helpers
  title: API