Skip to content

Add fabric.launch to Fabric methods section #17413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
carmocca opened this issue Apr 19, 2023 · 1 comment · Fixed by #17437
Closed

Add fabric.launch to Fabric methods section #17413

carmocca opened this issue Apr 19, 2023 · 1 comment · Fixed by #17437
Assignees
Labels
docs Documentation related fabric lightning.fabric.Fabric
Milestone

Comments

@carmocca
Copy link
Contributor

carmocca commented Apr 19, 2023

📚 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

@carmocca carmocca added docs Documentation related fabric lightning.fabric.Fabric labels Apr 19, 2023
@carmocca carmocca added this to the future milestone Apr 19, 2023
@awaelchli
Copy link
Contributor

It was not included at the time because we didn't know if it would survive. Fabric.launch is the leftover of what used to be Lite.run(). Since then, we have included the launch in several examples and docs and so far there were no objections to it. I think it is reasonable now to add it to the method list and spell out what it does.

The guide for using it in notebooks is here: https://lightning.ai/docs/fabric/latest/fundamentals/notebooks.html?highlight=notebook
And the regular use is documented here: https://lightning.ai/docs/fabric/latest/fundamentals/launch.html#simple-launch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related fabric lightning.fabric.Fabric
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants