_toctree.yml 9.52 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
25
  - local: task_summary
    title: Summary of the tasks
  - local: model_summary
    title: Summary of the models
  - local: training
    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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
- sections:
  - local: examples
    title: Examples
  - local: troubleshooting
    title: Troubleshooting
  - local: custom_datasets
    title: Fine-tuning with custom datasets
  - 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
69
    title: Exporting 馃 Transformers models
70
71
  - local: custom_models
    title: Sharing custom models
72
73
  - local: pr_checks
    title: Checks on a Pull Request
Sylvain Gugger's avatar
Sylvain Gugger committed
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
  title: Advanced guides
- 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
97
98
    - local: main_classes/onnx
      title: ONNX
Sylvain Gugger's avatar
Sylvain Gugger committed
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
    - 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
133
    - local: model_doc/bert-generation
Sylvain Gugger's avatar
Sylvain Gugger committed
134
      title: BertGeneration
135
    - local: model_doc/bert-japanese
Sylvain Gugger's avatar
Sylvain Gugger committed
136
      title: BertJapanese
137
    - local: model_doc/big_bird
Sylvain Gugger's avatar
Sylvain Gugger committed
138
139
140
141
142
      title: BigBird
    - local: model_doc/bigbird_pegasus
      title: BigBirdPegasus
    - local: model_doc/blenderbot
      title: Blenderbot
143
    - local: model_doc/blenderbot-small
Sylvain Gugger's avatar
Sylvain Gugger committed
144
145
146
147
148
149
150
151
152
      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
153
154
    - local: model_doc/convnext
      title: ConvNeXT
Sylvain Gugger's avatar
Sylvain Gugger committed
155
156
157
158
159
160
161
162
163
164
    - local: model_doc/clip
      title: CLIP
    - local: model_doc/convbert
      title: ConvBERT
    - local: model_doc/cpm
      title: CPM
    - local: model_doc/ctrl
      title: CTRL
    - local: model_doc/deberta
      title: DeBERTa
165
    - local: model_doc/deberta-v2
Sylvain Gugger's avatar
Sylvain Gugger committed
166
167
168
169
170
171
172
173
174
175
176
177
178
      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
179
    - local: model_doc/encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
180
181
182
183
      title: Encoder Decoder Models
    - local: model_doc/flaubert
      title: FlauBERT
    - local: model_doc/fnet
184
      title: FNet
Sylvain Gugger's avatar
Sylvain Gugger committed
185
186
187
188
189
    - local: model_doc/fsmt
      title: FSMT
    - local: model_doc/funnel
      title: Funnel Transformer
    - local: model_doc/herbert
190
      title: HerBERT
Sylvain Gugger's avatar
Sylvain Gugger committed
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
    - 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
215
    - local: model_doc/megatron-bert
Sylvain Gugger's avatar
Sylvain Gugger committed
216
217
218
      title: MegatronBERT
    - local: model_doc/megatron_gpt2
      title: MegatronGPT2
219
220
    - local: model_doc/mluke
      title: MLUKE
Sylvain Gugger's avatar
Sylvain Gugger committed
221
222
    - local: model_doc/mobilebert
      title: MobileBERT
223
224
    - local: model_doc/mluke
      title: mLUKE
Sylvain Gugger's avatar
Sylvain Gugger committed
225
226
227
228
    - local: model_doc/mpnet
      title: MPNet
    - local: model_doc/mt5
      title: MT5
novice's avatar
novice committed
229
230
    - local: model_doc/nystromformer
      title: Nystr枚mformer
231
    - local: model_doc/openai-gpt
Sylvain Gugger's avatar
Sylvain Gugger committed
232
233
234
235
236
237
238
239
240
      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
241
242
    - local: model_doc/perceiver
      title: Perceiver
Sylvain Gugger's avatar
Sylvain Gugger committed
243
244
245
246
247
248
249
250
251
252
    - local: model_doc/pegasus
      title: Pegasus
    - local: model_doc/phobert
      title: PhoBERT
    - 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
253
254
    - local: model_doc/realm
      title: REALM
Sylvain Gugger's avatar
Sylvain Gugger committed
255
256
257
258
259
260
261
262
263
264
265
266
267
268
    - 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
269
    - local: model_doc/sew-d
Sylvain Gugger's avatar
Sylvain Gugger committed
270
      title: SEW-D
271
    - local: model_doc/speech-encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
272
273
274
275
276
277
278
279
280
      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
281
282
    - local: model_doc/swin
      title: Swin Transformer
Sylvain Gugger's avatar
Sylvain Gugger committed
283
284
285
286
287
288
    - local: model_doc/t5
      title: T5
    - local: model_doc/t5v1.1
      title: T5v1.1
    - local: model_doc/tapas
      title: TAPAS
289
    - local: model_doc/transfo-xl
Sylvain Gugger's avatar
Sylvain Gugger committed
290
291
292
293
294
      title: Transformer XL
    - local: model_doc/trocr
      title: TrOCR
    - local: model_doc/unispeech
      title: UniSpeech
295
    - local: model_doc/unispeech-sat
Sylvain Gugger's avatar
Sylvain Gugger committed
296
      title: UniSpeech-SAT
NielsRogge's avatar
NielsRogge committed
297
298
    - local: model_doc/vilt
      title: ViLT
299
    - local: model_doc/vision-encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
300
      title: Vision Encoder Decoder Models
301
    - local: model_doc/vision-text-dual-encoder
302
      title: Vision Text Dual Encoder
Sylvain Gugger's avatar
Sylvain Gugger committed
303
304
    - local: model_doc/vit
      title: Vision Transformer (ViT)
NielsRogge's avatar
NielsRogge committed
305
306
    - local: model_doc/vit_mae
      title: ViTMAE
Sylvain Gugger's avatar
Sylvain Gugger committed
307
308
309
310
    - local: model_doc/visual_bert
      title: VisualBERT
    - local: model_doc/wav2vec2
      title: Wav2Vec2
311
312
    - local: model_doc/wav2vec2_phoneme
      title: Wav2Vec2Phoneme
Patrick von Platen's avatar
Patrick von Platen committed
313
314
    - local: model_doc/wavlm
      title: WavLM
Suraj Patil's avatar
Suraj Patil committed
315
316
    - local: model_doc/xglm
      title: XGLM
Sylvain Gugger's avatar
Sylvain Gugger committed
317
318
    - local: model_doc/xlm
      title: XLM
319
    - local: model_doc/xlm-prophetnet
Sylvain Gugger's avatar
Sylvain Gugger committed
320
      title: XLM-ProphetNet
321
    - local: model_doc/xlm-roberta
Sylvain Gugger's avatar
Sylvain Gugger committed
322
      title: XLM-RoBERTa
323
324
    - local: model_doc/xlm-roberta-xl
      title: XLM-RoBERTa-XL
Sylvain Gugger's avatar
Sylvain Gugger committed
325
326
327
328
    - local: model_doc/xlnet
      title: XLNet
    - local: model_doc/xlsr_wav2vec2
      title: XLSR-Wav2Vec2
329
330
    - local: model_doc/xls_r
      title: XLS-R
novice's avatar
novice committed
331
332
    - local: model_doc/yoso
      title: YOSO
Sylvain Gugger's avatar
Sylvain Gugger committed
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
    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