Skip to content

Commit 2173c00

Browse files
author
Lee Newberg
committed
DOC: Document and test the torch and tensorflow optional packages
1 parent 9bdcb46 commit 2173c00

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ sudo apt install -y python3-openslide openslide-tools
1616
pip install histomics_stream 'large_image[openslide]' \
1717
scikit_image --find-links https://girder.github.io/large_image_wheels
1818
```
19-
Note that additional image readers can be supported by using, e.g., `large_image[openslide,ometiff,openjpeg,bioformats]` instead of `large_image[openslide]`.
19+
Additional functionality is supported with subpackages, e.g., `histomics_stream[tensorflow,torch,zarr]`. These packages are optional when histomics_stream is used only for masking and/or organizing image tiles into larger image chunks that are more efficient to read than individual image tiles. However, if you are creating a tensorflow `Dataset` or a pytorch `DataLoader` then you will need the corresponding packages.
20+
21+
Additional image readers can be supported by using, e.g., `large_image[openslide,ometiff,openjpeg,bioformats]` instead of `large_image[openslide]`.
2022

2123
After launching `python3`, import the `histomics_stream` package with:
2224

example/pytorch_stream.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"!apt update\n",
3434
"!apt install -y python3-openslide openslide-tools\n",
3535
"!pip install 'large_image[openslide,tiff]' --find-links https://girder.github.io/large_image_wheels\n",
36-
"!pip install histomics_stream\n",
36+
"!pip install histomics_stream[torch]\n",
3737
"\n",
3838
"# Get other packages used in this notebook\n",
3939
"# N.B. itkwidgets works with jupyter<=3.0.0\n",

example/tensorflow_stream.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"!apt update\n",
3434
"!apt install -y python3-openslide openslide-tools\n",
3535
"!pip install 'large_image[openslide,tiff]' --find-links https://girder.github.io/large_image_wheels\n",
36-
"!pip install histomics_stream\n",
36+
"!pip install histomics_stream[tensorflow]\n",
3737
"\n",
3838
"# Get other packages used in this notebook\n",
3939
"# N.B. itkwidgets works with jupyter<=3.0.0\n",

0 commit comments

Comments
 (0)