Skip to content

Commit cfd00d3

Browse files
akihironittanohalonBorda
authored
Document running dev lightning on the cloud (#15962)
* document running dev lightning on the cloud * document running dev lightning on the cloud * Update .github/CONTRIBUTING.md Co-authored-by: Noha Alon <[email protected]> * document running dev lightning on the cloud * git clone & pip install -e * Update .github/CONTRIBUTING.md Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Noha Alon <[email protected]> Co-authored-by: Jirka Borovec <[email protected]>
1 parent 90a4c02 commit cfd00d3

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,20 @@ and the last true master commit is `ccc111` and your first commit is `mmm222`.
309309
git push -f
310310
```
311311

312+
#### How to run an app on the cloud with a local version of lightning
313+
314+
The lightning cloud uses the latest release by default. However, you might want to run your app with some local changes you've made to the lightning framework. To use your local version of lightning on the cloud, set the following environment variable:
315+
316+
```bash
317+
git clone https://github.com/Lightning-AI/lightning.git
318+
cd lightning
319+
pip install -e .
320+
export PACKAGE_LIGHTNING=1 # <- this is the magic to use your version (not mainstream PyPI)!
321+
lightning run app app.py --cloud
322+
```
323+
324+
By seting `PACKAGE_LIGHTNING=1`, lightning packages the lightning source code in your local directory in addition to your app source code and uploads them to the cloud.
325+
312326
### Bonus Workflow Tip
313327

314328
If you don't want to remember all the commands above every time you want to push some code/setup a Lightning Dev environment on a new VM, you can set up bash aliases for some common commands. You can add these to one of your `~/.bashrc`, `~/.zshrc`, or `~/.bash_aliases` files.

0 commit comments

Comments
 (0)