Skip to content

Add fabric.launch to Fabric methods sectionΒ #17413

@carmocca

Description

@carmocca

πŸ“š Documentation

fabric.launch() is a key method of L.Fabric but it's not included in https://lightning.ai/docs/fabric/stable/api/fabric_methods.html

The API reference: https://lightning.ai/docs/fabric/stable/api/generated/lightning.fabric.fabric.Fabric.html#lightning.fabric.fabric.Fabric.launch exists but is not very thorough.

The methods section would be a good place to describe the multiple .launch() flavors (CLI, no callable, callable) and when should each be used.
For instance, with TPUs, you need to pass a function. The CLI and putting the code after doesn't work.

cc @Borda @carmocca @justusschock @awaelchli

Metadata

Metadata

Assignees

Labels

docsDocumentation relatedfabriclightning.fabric.Fabric

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions