"vscode:/vscode.git/clone" did not exist on "07c54413ac24f891fc37920f6c61ad8b7b035dc3"
_toctree.yml 9.23 KB
Newer Older
Sylvain Gugger's avatar
Sylvain Gugger committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
- 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:
  - local: task_summary
    title: Summary of the tasks
  - local: model_summary
    title: Summary of the models
  - local: preprocessing
    title: Preprocessing data
  - local: training
    title: Fine-tuning a pretrained model
22
23
  - local: accelerate
    title: Distributed training with 馃 Accelerate
Sylvain Gugger's avatar
Sylvain Gugger committed
24
  - local: model_sharing
25
    title: Share a model
Sylvain Gugger's avatar
Sylvain Gugger committed
26
27
28
29
30
31
32
33
34
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
  - local: tokenizer_summary
    title: Summary of the tokenizers
  - local: multilingual
    title: Multi-lingual models
  title: "Using 馃 Transformers"
- 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
65
    title: Exporting 馃 Transformers models
66
67
  - local: pr_checks
    title: Checks on a Pull Request
Sylvain Gugger's avatar
Sylvain Gugger committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
  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
91
92
    - local: main_classes/onnx
      title: ONNX
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
115
116
117
118
119
120
121
122
123
124
125
126
    - 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
127
    - local: model_doc/bert-generation
Sylvain Gugger's avatar
Sylvain Gugger committed
128
      title: BertGeneration
129
    - local: model_doc/bert-japanese
Sylvain Gugger's avatar
Sylvain Gugger committed
130
      title: BertJapanese
131
    - local: model_doc/big_bird
Sylvain Gugger's avatar
Sylvain Gugger committed
132
133
134
135
136
      title: BigBird
    - local: model_doc/bigbird_pegasus
      title: BigBirdPegasus
    - local: model_doc/blenderbot
      title: Blenderbot
137
    - local: model_doc/blenderbot-small
Sylvain Gugger's avatar
Sylvain Gugger committed
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
      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
    - 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
157
    - local: model_doc/deberta-v2
Sylvain Gugger's avatar
Sylvain Gugger committed
158
159
160
161
162
163
164
165
166
167
168
169
170
      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
171
    - local: model_doc/encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
172
173
174
175
      title: Encoder Decoder Models
    - local: model_doc/flaubert
      title: FlauBERT
    - local: model_doc/fnet
176
      title: FNet
Sylvain Gugger's avatar
Sylvain Gugger committed
177
178
179
180
181
    - local: model_doc/fsmt
      title: FSMT
    - local: model_doc/funnel
      title: Funnel Transformer
    - local: model_doc/herbert
182
      title: HerBERT
Sylvain Gugger's avatar
Sylvain Gugger committed
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
    - 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
207
    - local: model_doc/megatron-bert
Sylvain Gugger's avatar
Sylvain Gugger committed
208
209
210
      title: MegatronBERT
    - local: model_doc/megatron_gpt2
      title: MegatronGPT2
211
212
    - local: model_doc/mluke
      title: MLUKE
Sylvain Gugger's avatar
Sylvain Gugger committed
213
214
    - local: model_doc/mobilebert
      title: MobileBERT
215
216
    - local: model_doc/mluke
      title: mLUKE
Sylvain Gugger's avatar
Sylvain Gugger committed
217
218
219
220
    - local: model_doc/mpnet
      title: MPNet
    - local: model_doc/mt5
      title: MT5
novice's avatar
novice committed
221
222
    - local: model_doc/nystromformer
      title: Nystr枚mformer
223
    - local: model_doc/openai-gpt
Sylvain Gugger's avatar
Sylvain Gugger committed
224
225
226
227
228
229
230
231
232
      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
233
234
    - local: model_doc/perceiver
      title: Perceiver
Sylvain Gugger's avatar
Sylvain Gugger committed
235
236
237
238
239
240
241
242
243
244
    - 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
245
246
    - local: model_doc/realm
      title: REALM
Sylvain Gugger's avatar
Sylvain Gugger committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
    - 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
261
    - local: model_doc/sew-d
Sylvain Gugger's avatar
Sylvain Gugger committed
262
      title: SEW-D
263
    - local: model_doc/speech-encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
264
265
266
267
268
269
270
271
272
      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
273
274
    - local: model_doc/swin
      title: Swin Transformer
Sylvain Gugger's avatar
Sylvain Gugger committed
275
276
277
278
279
280
    - local: model_doc/t5
      title: T5
    - local: model_doc/t5v1.1
      title: T5v1.1
    - local: model_doc/tapas
      title: TAPAS
281
    - local: model_doc/transfo-xl
Sylvain Gugger's avatar
Sylvain Gugger committed
282
283
284
285
286
      title: Transformer XL
    - local: model_doc/trocr
      title: TrOCR
    - local: model_doc/unispeech
      title: UniSpeech
287
    - local: model_doc/unispeech-sat
Sylvain Gugger's avatar
Sylvain Gugger committed
288
      title: UniSpeech-SAT
NielsRogge's avatar
NielsRogge committed
289
290
    - local: model_doc/vilt
      title: ViLT
291
    - local: model_doc/vision-encoder-decoder
Sylvain Gugger's avatar
Sylvain Gugger committed
292
      title: Vision Encoder Decoder Models
293
    - local: model_doc/vision-text-dual-encoder
294
      title: Vision Text Dual Encoder
Sylvain Gugger's avatar
Sylvain Gugger committed
295
296
    - local: model_doc/vit
      title: Vision Transformer (ViT)
NielsRogge's avatar
NielsRogge committed
297
298
    - local: model_doc/vit_mae
      title: ViTMAE
Sylvain Gugger's avatar
Sylvain Gugger committed
299
300
301
302
    - local: model_doc/visual_bert
      title: VisualBERT
    - local: model_doc/wav2vec2
      title: Wav2Vec2
303
304
    - local: model_doc/wav2vec2_phoneme
      title: Wav2Vec2Phoneme
Patrick von Platen's avatar
Patrick von Platen committed
305
306
    - local: model_doc/wavlm
      title: WavLM
Suraj Patil's avatar
Suraj Patil committed
307
308
    - local: model_doc/xglm
      title: XGLM
Sylvain Gugger's avatar
Sylvain Gugger committed
309
310
    - local: model_doc/xlm
      title: XLM
311
    - local: model_doc/xlm-prophetnet
Sylvain Gugger's avatar
Sylvain Gugger committed
312
      title: XLM-ProphetNet
313
    - local: model_doc/xlm-roberta
Sylvain Gugger's avatar
Sylvain Gugger committed
314
315
316
317
318
      title: XLM-RoBERTa
    - local: model_doc/xlnet
      title: XLNet
    - local: model_doc/xlsr_wav2vec2
      title: XLSR-Wav2Vec2
319
320
    - local: model_doc/xls_r
      title: XLS-R
novice's avatar
novice committed
321
322
    - local: model_doc/yoso
      title: YOSO
Sylvain Gugger's avatar
Sylvain Gugger committed
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
    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