_toctree.yml 10.2 KB
Newer Older
Sylvain Gugger's avatar
Sylvain Gugger committed
1
2
3
4
5
6
7
8
9
10
11
12
13
- sections: 
  - local: index
    title: 馃 Transformers
  - local: quicktour
    title: Quick tour
  - local: installation
    title: Installation
  - local: philosophy
    title: Philosophy
  - local: glossary
    title: Glossary
  title: Get started
- sections:
Steven Liu's avatar
Steven Liu committed
14
15
16
17
18
19
  - 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
20
21
22
23
24
  - local: task_summary
    title: Summary of the tasks
  - local: model_summary
    title: Summary of the models
  - local: training
Steven Liu's avatar
Steven Liu committed
25
    title: Fine-tuning a pretrained model
26
27
  - local: accelerate
    title: Distributed training with 馃 Accelerate
Sylvain Gugger's avatar
Sylvain Gugger committed
28
  - local: model_sharing
29
    title: Share a model
Sylvain Gugger's avatar
Sylvain Gugger committed
30
31
32
33
  - local: tokenizer_summary
    title: Summary of the tokenizers
  - local: multilingual
    title: Multi-lingual models
Steven Liu's avatar
Steven Liu committed
34
  title: Tutorials
Sylvain Gugger's avatar
Sylvain Gugger committed
35
- sections:
36
37
  - local: create_a_model
    title: Create a custom model
Sylvain Gugger's avatar
Sylvain Gugger committed
38
39
40
41
42
43
  - local: examples
    title: Examples
  - local: troubleshooting
    title: Troubleshooting
  - local: custom_datasets
    title: Fine-tuning with custom datasets
Steven Liu's avatar
Steven Liu committed
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
  - 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
    title: Fine-tune for downstream tasks
Sylvain Gugger's avatar
Sylvain Gugger committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
  - local: notebooks
    title: "馃 Transformers Notebooks"
  - local: sagemaker
    title: Run training on Amazon SageMaker
  - local: community
    title: Community
  - local: converting_tensorflow_models
    title: Converting Tensorflow Checkpoints
  - local: migration
    title: Migrating from previous packages
  - 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?"
  - local: fast_tokenizers
    title: "Using tokenizers from 馃 Tokenizers"
  - local: performance
    title: 'Performance and Scalability: How To Fit a Bigger Model and Train It Faster'
  - local: parallelism
    title: Model Parallelism
  - local: testing
    title: Testing
  - local: debugging
    title: Debugging
  - local: serialization
87
    title: Exporting 馃 Transformers models
88
89
  - local: custom_models
    title: Sharing custom models
90
91
  - local: pr_checks
    title: Checks on a Pull Request
Steven Liu's avatar
Steven Liu committed
92
  title: How-to guides
Sylvain Gugger's avatar
Sylvain Gugger committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
- sections:
  - local: bertology
    title: BERTology
  - local: perplexity
    title: Perplexity of fixed-length models
  - local: benchmarks
    title: Benchmarks
  title: Research
- 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
115
116
    - local: main_classes/onnx
      title: ONNX
Sylvain Gugger's avatar
Sylvain Gugger committed
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
    - 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
151
    - local: model_doc/bert-generation
Sylvain Gugger's avatar
Sylvain Gugger committed
152
      title: BertGeneration
153
    - local: model_doc/bert-japanese
Sylvain Gugger's avatar
Sylvain Gugger committed
154
      title: BertJapanese
155
    - local: model_doc/big_bird
Sylvain Gugger's avatar
Sylvain Gugger committed
156
157
158
159
160
      title: BigBird
    - local: model_doc/bigbird_pegasus
      title: BigBirdPegasus
    - local: model_doc/blenderbot
      title: Blenderbot
161
    - local: model_doc/blenderbot-small
Sylvain Gugger's avatar
Sylvain Gugger committed
162
163
164
165
166
167
168
169
170
      title: Blenderbot Small
    - 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
171
172
    - local: model_doc/convnext
      title: ConvNeXT
Sylvain Gugger's avatar
Sylvain Gugger committed
173
174
175
176
177
178
179
180
    - local: model_doc/clip
      title: CLIP
    - local: model_doc/convbert
      title: ConvBERT
    - local: model_doc/cpm
      title: CPM
    - local: model_doc/ctrl
      title: CTRL
181
182
    - local: model_doc/data2vec
      title: Data2Vec
Sylvain Gugger's avatar
Sylvain Gugger committed
183
184
    - local: model_doc/deberta
      title: DeBERTa
185
    - local: model_doc/deberta-v2
Sylvain Gugger's avatar
Sylvain Gugger committed
186
187
188
189
190
191
192
193
194
195
196
197
198
      title: DeBERTa-v2
    - local: model_doc/deit
      title: DeiT
    - local: model_doc/detr
      title: DETR
    - local: model_doc/dialogpt
      title: DialoGPT
    - local: model_doc/distilbert
      title: DistilBERT
    - local: model_doc/dpr
      title: DPR
    - local: model_doc/electra
      title: ELECTRA
199
    - local: model_doc/encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
200
201
202
203
      title: Encoder Decoder Models
    - local: model_doc/flaubert
      title: FlauBERT
    - local: model_doc/fnet
204
      title: FNet
Sylvain Gugger's avatar
Sylvain Gugger committed
205
206
207
208
209
    - local: model_doc/fsmt
      title: FSMT
    - local: model_doc/funnel
      title: Funnel Transformer
    - local: model_doc/herbert
210
      title: HerBERT
Sylvain Gugger's avatar
Sylvain Gugger committed
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
    - 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
    - local: model_doc/layoutxlm
      title: LayoutXLM
    - local: model_doc/led
      title: LED
    - local: model_doc/longformer
      title: Longformer
    - local: model_doc/luke
      title: LUKE
    - local: model_doc/lxmert
      title: LXMERT
    - local: model_doc/marian
      title: MarianMT
    - local: model_doc/m2m_100
      title: M2M100
    - local: model_doc/mbart
      title: MBart and MBart-50
235
    - local: model_doc/megatron-bert
Sylvain Gugger's avatar
Sylvain Gugger committed
236
237
238
      title: MegatronBERT
    - local: model_doc/megatron_gpt2
      title: MegatronGPT2
239
240
    - local: model_doc/mluke
      title: MLUKE
Sylvain Gugger's avatar
Sylvain Gugger committed
241
242
    - local: model_doc/mobilebert
      title: MobileBERT
243
244
    - local: model_doc/mluke
      title: mLUKE
Sylvain Gugger's avatar
Sylvain Gugger committed
245
246
247
248
    - local: model_doc/mpnet
      title: MPNet
    - local: model_doc/mt5
      title: MT5
novice's avatar
novice committed
249
250
    - local: model_doc/nystromformer
      title: Nystr枚mformer
251
    - local: model_doc/openai-gpt
Sylvain Gugger's avatar
Sylvain Gugger committed
252
253
254
255
256
257
258
259
260
      title: OpenAI GPT
    - local: model_doc/gpt2
      title: OpenAI GPT2
    - local: model_doc/gptj
      title: GPT-J
    - local: model_doc/gpt_neo
      title: GPT Neo
    - local: model_doc/hubert
      title: Hubert
261
262
    - local: model_doc/perceiver
      title: Perceiver
Sylvain Gugger's avatar
Sylvain Gugger committed
263
264
265
266
    - local: model_doc/pegasus
      title: Pegasus
    - local: model_doc/phobert
      title: PhoBERT
Gunjan Chhablani's avatar
Gunjan Chhablani committed
267
268
    - local: model_doc/plbart
      title: PLBart
Tanay Mehta's avatar
Tanay Mehta committed
269
270
    - local: model_doc/poolformer
      title: PoolFormer
Sylvain Gugger's avatar
Sylvain Gugger committed
271
272
273
274
275
276
    - 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
277
278
    - local: model_doc/realm
      title: REALM
Sylvain Gugger's avatar
Sylvain Gugger committed
279
280
281
282
283
284
285
286
287
288
289
290
291
292
    - local: model_doc/reformer
      title: Reformer
    - local: model_doc/rembert
      title: RemBERT
    - 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
293
    - local: model_doc/sew-d
Sylvain Gugger's avatar
Sylvain Gugger committed
294
      title: SEW-D
295
    - local: model_doc/speech-encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
296
297
298
299
300
301
302
303
304
      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
305
306
    - local: model_doc/swin
      title: Swin Transformer
Sylvain Gugger's avatar
Sylvain Gugger committed
307
308
309
310
311
312
    - local: model_doc/t5
      title: T5
    - local: model_doc/t5v1.1
      title: T5v1.1
    - local: model_doc/tapas
      title: TAPAS
313
    - local: model_doc/transfo-xl
Sylvain Gugger's avatar
Sylvain Gugger committed
314
315
316
317
318
      title: Transformer XL
    - local: model_doc/trocr
      title: TrOCR
    - local: model_doc/unispeech
      title: UniSpeech
319
    - local: model_doc/unispeech-sat
Sylvain Gugger's avatar
Sylvain Gugger committed
320
      title: UniSpeech-SAT
NielsRogge's avatar
NielsRogge committed
321
322
    - local: model_doc/vilt
      title: ViLT
323
    - local: model_doc/vision-encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
324
      title: Vision Encoder Decoder Models
325
    - local: model_doc/vision-text-dual-encoder
326
      title: Vision Text Dual Encoder
Sylvain Gugger's avatar
Sylvain Gugger committed
327
328
    - local: model_doc/vit
      title: Vision Transformer (ViT)
NielsRogge's avatar
NielsRogge committed
329
330
    - local: model_doc/vit_mae
      title: ViTMAE
Sylvain Gugger's avatar
Sylvain Gugger committed
331
332
333
334
    - local: model_doc/visual_bert
      title: VisualBERT
    - local: model_doc/wav2vec2
      title: Wav2Vec2
335
336
    - local: model_doc/wav2vec2_phoneme
      title: Wav2Vec2Phoneme
Patrick von Platen's avatar
Patrick von Platen committed
337
338
    - local: model_doc/wavlm
      title: WavLM
Suraj Patil's avatar
Suraj Patil committed
339
340
    - local: model_doc/xglm
      title: XGLM
Sylvain Gugger's avatar
Sylvain Gugger committed
341
342
    - local: model_doc/xlm
      title: XLM
343
    - local: model_doc/xlm-prophetnet
Sylvain Gugger's avatar
Sylvain Gugger committed
344
      title: XLM-ProphetNet
345
    - local: model_doc/xlm-roberta
Sylvain Gugger's avatar
Sylvain Gugger committed
346
      title: XLM-RoBERTa
347
348
    - local: model_doc/xlm-roberta-xl
      title: XLM-RoBERTa-XL
Sylvain Gugger's avatar
Sylvain Gugger committed
349
350
351
352
    - local: model_doc/xlnet
      title: XLNet
    - local: model_doc/xlsr_wav2vec2
      title: XLSR-Wav2Vec2
353
354
    - local: model_doc/xls_r
      title: XLS-R
novice's avatar
novice committed
355
356
    - local: model_doc/yoso
      title: YOSO
Sylvain Gugger's avatar
Sylvain Gugger committed
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
    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