1
1
.. include :: links.rst
2
2
3
- ################
4
- Lightning Fabric
5
- ################
3
+ ####################
4
+ Welcome to ⚡ Fabric
5
+ ####################
6
6
7
7
Fabric is the fast and lightweight way to scale PyTorch models without boilerplate code.
8
8
@@ -102,173 +102,6 @@ Fabric ships directly with Lightning. Install it with
102
102
103
103
For alternative ways to install, read the :doc: `installation guide <fundamentals/installation >`.
104
104
105
- ----
106
-
107
-
108
- ************
109
- Fundamentals
110
- ************
111
-
112
- .. raw :: html
113
-
114
- <div class =" display-card-container" >
115
- <div class =" row" >
116
-
117
- .. displayitem ::
118
- :header: Getting Started
119
- :description: Learn how to add Fabric to your PyTorch code
120
- :button_link: fundamentals/convert.html
121
- :col_css: col-md-4
122
- :height: 150
123
- :tag: basic
124
-
125
- .. displayitem ::
126
- :header: Accelerators
127
- :description: Take advantage of your hardware with a switch of a flag
128
- :button_link: fundamentals/accelerators.html
129
- :col_css: col-md-4
130
- :height: 150
131
- :tag: intermediate
132
-
133
- .. displayitem ::
134
- :header: Code Structure
135
- :description: Best practices for setting up your training script with Fabric
136
- :button_link: fundamentals/code_structure.html
137
- :col_css: col-md-4
138
- :height: 150
139
- :tag: basic
140
-
141
- .. displayitem ::
142
- :header: Launch Distributed Training
143
- :description: Launch a Python script on multiple devices and machines
144
- :button_link: fundamentals/launch.html
145
- :col_css: col-md-4
146
- :height: 150
147
- :tag: intermediate
148
-
149
- .. displayitem ::
150
- :header: Fabric in Notebooks
151
- :description: Launch on multiple devices from within a Jupyter notebook
152
- :button_link: fundamentals/notebooks.html
153
- :col_css: col-md-4
154
- :height: 150
155
- :tag: basic
156
-
157
- .. displayitem ::
158
- :header: Mixed Precision Training
159
- :description: Save memory and speed up training using mixed precision
160
- :button_link: fundamentals/precision.html
161
- :col_css: col-md-4
162
- :height: 150
163
- :tag: intermediate
164
-
165
- .. raw :: html
166
-
167
- </div >
168
- </div >
169
-
170
-
171
- ----
172
-
173
-
174
- **********************
175
- Build Your Own Trainer
176
- **********************
177
-
178
- .. raw :: html
179
-
180
- <div class =" display-card-container" >
181
- <div class =" row" >
182
-
183
- .. displayitem ::
184
- :header: The LightningModule
185
- :description: Organize your code in a LightningModule and use it with Fabric
186
- :button_link: guide/lightning_module.html
187
- :col_css: col-md-4
188
- :height: 150
189
- :tag: basic
190
-
191
- .. displayitem ::
192
- :header: Callbacks
193
- :description: Make use of the Callback system in Fabric
194
- :button_link: guide/callbacks.html
195
- :col_css: col-md-4
196
- :height: 150
197
- :tag: basic
198
-
199
- .. displayitem ::
200
- :header: Logging
201
- :description: Learn how Fabric helps you remove boilerplate code for tracking metrics with a logger
202
- :button_link: guide/logging.html
203
- :col_css: col-md-4
204
- :height: 150
205
- :tag: basic
206
-
207
- .. displayitem ::
208
- :header: Checkpoints
209
- :description: Efficient saving and loading of model weights, training state, hyperparameters and more.
210
- :button_link: guide/checkpoint.html
211
- :col_css: col-md-4
212
- :height: 150
213
- :tag: basic
214
-
215
- .. displayitem ::
216
- :header: Trainer Template
217
- :description: Take our Fabric Trainer template and customize it for your needs
218
- :button_link: https://github.com/Lightning-AI/lightning/tree/master/examples/fabric/build_your_own_trainer
219
- :col_css: col-md-4
220
- :height: 150
221
- :tag: intermediate
222
-
223
- .. raw :: html
224
-
225
- </div >
226
- </div >
227
-
228
-
229
- ----
230
-
231
-
232
- ***************
233
- Advanced Topics
234
- ***************
235
-
236
- .. raw :: html
237
-
238
- <div class =" display-card-container" >
239
- <div class =" row" >
240
-
241
- .. displayitem ::
242
- :header: Efficient Gradient Accumulation
243
- :description: Learn how to perform efficient gradient accumulation in distributed settings
244
- :button_link: advanced/gradient_accumulation.html
245
- :col_css: col-md-4
246
- :height: 160
247
- :tag: advanced
248
-
249
- .. displayitem ::
250
- :header: Distributed Communication
251
- :description: Learn all about communication primitives for distributed operation. Gather, reduce, broadcast, etc.
252
- :button_link: advanced/distributed_communication.html
253
- :col_css: col-md-4
254
- :height: 160
255
- :tag: advanced
256
-
257
- .. displayitem ::
258
- :header: Multiple Models and Optimizers
259
- :description: See how flexible Fabric is to work with multiple models and optimizers!
260
- :button_link: advanced/multiple_setup.html
261
- :col_css: col-md-4
262
- :height: 160
263
- :tag: advanced
264
-
265
- .. raw :: html
266
-
267
- </div >
268
- </div >
269
-
270
-
271
- ----
272
105
273
106
274
107
.. raw :: html
@@ -278,60 +111,40 @@ Advanced Topics
278
111
.. toctree ::
279
112
:maxdepth: 1
280
113
:name: start
281
- :caption: Get Started
282
-
283
- Fabric in 5 minutes <fundamentals/convert >
284
- Installation <fundamentals/installation >
285
-
286
- .. toctree ::
287
- :maxdepth: 1
288
- :name: fundamentals
289
- :caption: Fundamentals
114
+ :caption: Home
290
115
291
- Accelerators <fundamentals/accelerators >
292
- Code Structure <fundamentals/code_structure >
293
- Launch Distributed Training <fundamentals/launch >
294
- Fabric in Notebooks <fundamentals/notebooks >
295
- Mixed Precision Training <fundamentals/precision >
116
+ self
117
+ Install <fundamentals/installation >
296
118
297
- .. toctree ::
298
- :maxdepth: 1
299
- :name: byot
300
- :caption: Build Your Own Trainer
301
-
302
- The LightningModule <guide/lightning_module >
303
- Callbacks <guide/callbacks >
304
- Logging <guide/logging >
305
- Checkpoints <guide/checkpoint >
306
- Trainer Template <https://github.com/Lightning-AI/lightning/tree/master/examples/fabric/build_your_own_trainer >
307
119
308
120
.. toctree ::
309
- :maxdepth: 1
310
- :name: advanced
311
- :caption: Advanced Topics
121
+ :maxdepth: 1
122
+ :caption: Get started in steps
312
123
313
- Efficient Gradient Accumulation <advanced/gradient_accumulation >
314
- Distributed Communication <advanced/distributed_communication >
315
- Multiple Models and Optimizers <advanced/multiple_setup >
316
-
317
- .. toctree ::
318
- :maxdepth: 1
319
- :name: examples
320
- :caption: Examples
124
+ Basic <levels/basic >
125
+ Intermediate <levels/intermediate >
126
+ Advanced <levels/advanced >
321
127
322
- Examples <examples/index >
323
128
324
129
.. toctree ::
325
130
:maxdepth: 1
326
131
:name: api
327
- :caption: API Reference
132
+ :caption: Core API Reference
328
133
329
134
Fabric Arguments <api/fabric_args >
330
135
Fabric Methods <api/fabric_methods >
331
136
Utilities <api/utilities >
332
137
Full API Reference <api_reference >
333
138
334
139
140
+ .. toctree ::
141
+ :maxdepth: 1
142
+ :name: more
143
+ :caption: More
144
+
145
+ Examples <examples/index >
146
+
147
+
335
148
.. raw :: html
336
149
337
150
</div >
0 commit comments