Skip to content

Commit 7d9f1ae

Browse files
committed
update README
1 parent b3a2135 commit 7d9f1ae

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# lightstream
1+
# Lightstream
22

33
Lightstream is a Pytorch library to train CNN's with large input images. Parsing large inputs is achieved through a combination of
44
gradient checkpointing and tiling the input image. For a full overview of the streaming algorithm, please read the article:
@@ -21,6 +21,25 @@ We also recommend to install the albumentationsxl package, which is an albumenta
2121
pip install albumentationsxl
2222
```
2323

24+
25+
### Requirements
26+
The lightstream package requires PyTorch version 2.0 or greater to be installed, along with Pytorch lightning version 2.0.0 or greater.
27+
- PyTorch 2.0.0 or greater
28+
- Pytorch Lightning 2.0.0 or greater
29+
- Albumentationsxl (recommended)
30+
Furthermore, we recommend a GPU with at least 10 GB of VRAM, and a system with at least 32 GB of RAM.
31+
32+
33+
## Using lightstream with pre-trained networks
34+
lightstream offers several out-of-the-box streaming equivalents of ImageNet classifiers. Currently ResNet and ConvNext architectures are supported
35+
36+
```python
37+
import torch.nn
38+
from lightstream.models.resnet.resnet import StreamingResNet
39+
40+
model = StreamingResNet(model_name="resnet18", tile_size=2880, loss_fn=torch.nn.CrossEntropyLoss(), train_streaming_layers=True)
41+
```
42+
2443
## Documentation
2544
The documentation can be found at https://diagnijmegen.github.io/lightstream/
2645

@@ -29,7 +48,4 @@ Alternatively the documentation can be generated locally using
2948
```
3049
make docs
3150
```
32-
33-
34-
3551
##

0 commit comments

Comments
 (0)