From fa5da26e39bc9b19afa827b16789644ca3271dea Mon Sep 17 00:00:00 2001 From: William Falcon Date: Tue, 11 Jun 2024 10:04:51 -0400 Subject: [PATCH] Update README.md (#19968) --- README.md | 90 +++++++++++++++---------------------------------------- 1 file changed, 24 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index e9d5666c17..40ae9714d6 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,10 @@ ______________________________________________________________________

- Lightning.ai • + Lightning AI • + Examples • PyTorch Lightning • Fabric • - Lightning Apps • Docs • Community • Contribute • @@ -92,15 +92,11 @@ pip install -iU https://test.pypi.org/simple/ pytorch-lightning ______________________________________________________________________ -## Lightning has 4 core packages +## Lightning has 2 core packages [PyTorch Lightning: Train and deploy PyTorch at scale](#pytorch-lightning-train-and-deploy-pytorch-at-scale).
[Lightning Fabric: Expert control](#lightning-fabric-expert-control). -
-[Lightning Data: Blazing fast, distributed streaming of training data from cloud storage](https://github.com/Lightning-AI/pytorch-lightning/tree/master/src/lightning/data). -
-[Lightning Apps: Build AI products and ML workflows](#lightning-apps-build-ai-products-and-ml-workflows). Lightning gives you granular control over how much abstraction you want to add over PyTorch. @@ -108,7 +104,9 @@ Lightning gives you granular control over how much abstraction you want to add o -______________________________________________________________________ +  +  + # PyTorch Lightning: Train and Deploy PyTorch at Scale @@ -118,6 +116,15 @@ PyTorch Lightning is just organized PyTorch - Lightning disentangles PyTorch cod ______________________________________________________________________ +### Examples +Explore various types of training possible with PyTorch Lightning. Pretrain and finetune ANY kind of model to perform ANY task like classification, segmentation, summarization and more: + +| Task | Description | Run | +|---|---|---| +| [Hello world](#hello-simple-model) | Pretrain - Hello world example | Open In Studio | +| [Image segmentation](https://lightning.ai/lightning-ai/studios/image-segmentation-with-pytorch-lightning) | Finetune - ResNet-50 model to segment images | Open In Studio | +| [Text classification](https://lightning.ai/lightning-ai/studios/text-classification-with-pytorch-lightning) | Finetune - text classifier (BERT model) | Open In Studio | + ### Hello simple model ```python @@ -319,6 +326,9 @@ ______________________________________________________________________ ______________________________________________________________________ +  +  + # Lightning Fabric: Expert control. Run on any device at any scale with expert-level control over PyTorch training loop and scaling strategy. You can even write your own Trainer. @@ -501,62 +511,8 @@ ______________________________________________________________________ ______________________________________________________________________ -# Lightning Apps: Build AI products and ML workflows - -Lightning Apps remove the cloud infrastructure boilerplate so you can focus on solving the research or business problems. Lightning Apps can run on the Lightning Cloud, your own cluster or a private cloud. - -

- -
- -## Hello Lightning app world - -```python -# app.py -import lightning as L - - -class TrainComponent(L.LightningWork): - def run(self, x): - print(f"train a model on {x}") - - -class AnalyzeComponent(L.LightningWork): - def run(self, x): - print(f"analyze model on {x}") - - -class WorkflowOrchestrator(L.LightningFlow): - def __init__(self) -> None: - super().__init__() - self.train = TrainComponent(cloud_compute=L.CloudCompute("cpu")) - self.analyze = AnalyzeComponent(cloud_compute=L.CloudCompute("gpu")) - - def run(self): - self.train.run("CPU machine 1") - self.analyze.run("GPU machine 2") - - -app = L.LightningApp(WorkflowOrchestrator()) -``` - -Run on the cloud or locally - -```bash -# run on the cloud -lightning run app app.py --setup --cloud - -# run locally -lightning run app app.py -``` - -______________________________________________________________________ - -
- Read the Lightning Apps docs -
- -______________________________________________________________________ +  +  ## Examples @@ -587,7 +543,8 @@ ______________________________________________________________________ - [Logistic Regression](https://lightning-bolts.readthedocs.io/en/stable/models/classic_ml.html#logistic-regression) - [Linear Regression](https://lightning-bolts.readthedocs.io/en/stable/models/classic_ml.html#linear-regression) -______________________________________________________________________ +  +  ## Continuous Integration @@ -611,7 +568,8 @@ Lightning is rigorously tested across multiple CPUs, GPUs and TPUs and against m -______________________________________________________________________ +  +  ## Community