Skip to content

Commit 025c30e

Browse files
williamFalconwilliamFalcon
authored
Update README.md
1 parent 1551a16 commit 025c30e

File tree

1 file changed

+52
-49
lines changed

1 file changed

+52
-49
lines changed

‎README.md‎

Lines changed: 52 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@
1212
______________________________________________________________________
1313

1414
<p align="center">
15-
<a href="https://lightning.ai/">Lightning AI</a> •
15+
<a href="#quick-start" style="margin: 0 10px;">Quick start</a> •
1616
<a href="#examples">Examples</a> •
17-
<a href="#pytorch-lightning-train-and-deploy-pytorch-at-scale">PyTorch Lightning</a> •
17+
<a href="#why-pytorch-lightning">PyTorch Lightning</a> •
1818
<a href="#lightning-fabric-expert-control">Fabric</a> •
19-
<a href="https://pytorch-lightning.readthedocs.io/en/stable/">Docs</a> •
19+
<a href="https://lightning.ai/">Lightning AI</a> •
2020
<a href="#community">Community</a> •
21-
<a href="https://lightning.ai/docs/pytorch/stable/generated/CONTRIBUTING.html">Contribute</a> •
21+
<a href="https://pytorch-lightning.readthedocs.io/en/stable/">Docs</a>
2222
</p>
2323

2424
<!-- DO NOT ADD CONDA DOWNLOADS... README CHANGES MUST BE APPROVED BY EDEN OR WILL -->
@@ -53,9 +53,24 @@ ______________________________________________________________________
5353

5454
</div>
5555

56-
## Install Lightning
56+
&nbsp;
57+
58+
# Lightning has 2 core packages
59+
60+
[PyTorch Lightning: Train and deploy PyTorch at scale](#why-pytorch-lightning).
61+
<br/>
62+
[Lightning Fabric: Expert control](#lightning-fabric-expert-control).
63+
64+
Lightning gives you granular control over how much abstraction you want to add over PyTorch.
65+
66+
<div align="center">
67+
<img src="https://pl-public-data.s3.amazonaws.com/assets_lightning/continuum.png" width="80%">
68+
</div>
69+
70+
&nbsp;
5771

58-
Simple installation from PyPI
72+
# Quick start
73+
Install Lightning:
5974

6075
```bash
6176
pip install lightning
@@ -64,7 +79,7 @@ pip install lightning
6479
<!-- following section will be skipped from PyPI description -->
6580

6681
<details>
67-
<summary>Other installation options</summary>
82+
<summary>Advanced install options</summary>
6883
<!-- following section will be skipped from PyPI description -->
6984

7085
#### Install with optional dependencies
@@ -104,48 +119,8 @@ pip install -iU https://test.pypi.org/simple/ pytorch-lightning
104119
</details>
105120
<!-- end skipping PyPI description -->
106121

107-
______________________________________________________________________
108-
109-
## Lightning has 2 core packages
110-
111-
[PyTorch Lightning: Train and deploy PyTorch at scale](#pytorch-lightning-train-and-deploy-pytorch-at-scale).
112-
<br/>
113-
[Lightning Fabric: Expert control](#lightning-fabric-expert-control).
114-
115-
Lightning gives you granular control over how much abstraction you want to add over PyTorch.
116-
117-
<div align="center">
118-
<img src="https://pl-public-data.s3.amazonaws.com/assets_lightning/continuum.png" width="80%">
119-
</div>
120-
121-
&nbsp;
122-
&nbsp;
123-
124-
125-
# PyTorch Lightning: Train and Deploy PyTorch at Scale
126-
127-
PyTorch Lightning is just organized PyTorch - Lightning disentangles PyTorch code to decouple the science from the engineering.
128-
129-
![PT to PL](docs/source-pytorch/_static/images/general/pl_quick_start_full_compressed.gif)
130-
131-
______________________________________________________________________
132-
133-
### Examples
134-
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:
135-
136-
| Task | Description | Run |
137-
|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|---|
138-
| [Hello world](#hello-simple-model) | Pretrain - Hello world example | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/pytorch-lightning-hello-world"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
139-
| [Image classification](https://lightning.ai/lightning-ai/studios/image-classification-with-pytorch-lightning) | Finetune - ResNet-34 model to classify images of cars | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/image-classification-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
140-
| [Image segmentation](https://lightning.ai/lightning-ai/studios/image-segmentation-with-pytorch-lightning) | Finetune - ResNet-50 model to segment images | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/image-segmentation-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
141-
| [Object detection](https://lightning.ai/lightning-ai/studios/object-detection-with-pytorch-lightning) | Finetune - Faster R-CNN model to detect objects | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/object-detection-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
142-
| [Text classification](https://lightning.ai/lightning-ai/studios/text-classification-with-pytorch-lightning) | Finetune - text classifier (BERT model) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/text-classification-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
143-
| [Text summarization](https://lightning.ai/lightning-ai/studios/text-summarization-with-pytorch-lightning) | Finetune - text summarization (Hugging Face transformer model) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/text-summarization-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
144-
| [Audio generation](https://lightning.ai/lightning-ai/studios/finetune-a-personal-ai-music-generator) | Finetune - audio generator (transformer model) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/finetune-a-personal-ai-music-generator"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
145-
| [LLM finetuning](https://lightning.ai/lightning-ai/studios/finetune-an-llm-with-pytorch-lightning) | Finetune - LLM (Meta Llama 3.1 8B) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/finetune-an-llm-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
146-
| [Image generation](https://lightning.ai/lightning-ai/studios/train-a-diffusion-model-with-pytorch-lightning) | Pretrain - Image generator (diffusion model) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/train-a-diffusion-model-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
147-
148-
### Hello simple model
122+
### PyTorch Lightning example
123+
Define the training workflow. Here's a toy example ([explore real examples](https://lightning.ai/lightning-ai/studios?view=public&section=featured&query=pytorch+lightning)):
149124

150125
```python
151126
# main.py
@@ -207,6 +182,34 @@ pip install torchvision
207182
python main.py
208183
```
209184

185+
&nbsp;
186+
187+
188+
# Why PyTorch Lightning?
189+
190+
PyTorch Lightning is just organized PyTorch - Lightning disentangles PyTorch code to decouple the science from the engineering.
191+
192+
![PT to PL](docs/source-pytorch/_static/images/general/pl_quick_start_full_compressed.gif)
193+
194+
&nbsp;
195+
196+
----
197+
198+
### Examples
199+
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:
200+
201+
| Task | Description | Run |
202+
|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|---|
203+
| [Hello world](#hello-simple-model) | Pretrain - Hello world example | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/pytorch-lightning-hello-world"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
204+
| [Image classification](https://lightning.ai/lightning-ai/studios/image-classification-with-pytorch-lightning) | Finetune - ResNet-34 model to classify images of cars | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/image-classification-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
205+
| [Image segmentation](https://lightning.ai/lightning-ai/studios/image-segmentation-with-pytorch-lightning) | Finetune - ResNet-50 model to segment images | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/image-segmentation-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
206+
| [Object detection](https://lightning.ai/lightning-ai/studios/object-detection-with-pytorch-lightning) | Finetune - Faster R-CNN model to detect objects | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/object-detection-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
207+
| [Text classification](https://lightning.ai/lightning-ai/studios/text-classification-with-pytorch-lightning) | Finetune - text classifier (BERT model) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/text-classification-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
208+
| [Text summarization](https://lightning.ai/lightning-ai/studios/text-summarization-with-pytorch-lightning) | Finetune - text summarization (Hugging Face transformer model) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/text-summarization-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
209+
| [Audio generation](https://lightning.ai/lightning-ai/studios/finetune-a-personal-ai-music-generator) | Finetune - audio generator (transformer model) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/finetune-a-personal-ai-music-generator"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
210+
| [LLM finetuning](https://lightning.ai/lightning-ai/studios/finetune-an-llm-with-pytorch-lightning) | Finetune - LLM (Meta Llama 3.1 8B) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/finetune-an-llm-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
211+
| [Image generation](https://lightning.ai/lightning-ai/studios/train-a-diffusion-model-with-pytorch-lightning) | Pretrain - Image generator (diffusion model) | <a target="_blank" href="https://lightning.ai/lightning-ai/studios/train-a-diffusion-model-with-pytorch-lightning"><img src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/app-2/studio-badge.svg" alt="Open In Studio"/></a> |
212+
210213
______________________________________________________________________
211214

212215
## Advanced features

0 commit comments

Comments
 (0)