Skip to content

Commit

Permalink
DOC: Document the torch and tensorflow optional packages
Browse files Browse the repository at this point in the history
  • Loading branch information
Leengit committed Sep 16, 2024
1 parent 9bdcb46 commit 20cc0a0
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ sudo apt install -y python3-openslide openslide-tools
pip install histomics_stream 'large_image[openslide]' \
scikit_image --find-links https://girder.github.io/large_image_wheels
```
Note that additional image readers can be supported by using, e.g., `large_image[openslide,ometiff,openjpeg,bioformats]` instead of `large_image[openslide]`.
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.

Additional image readers can be supported by using, e.g., `large_image[openslide,ometiff,openjpeg,bioformats]` instead of `large_image[openslide]`.

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

Expand Down
2 changes: 1 addition & 1 deletion example/pytorch_stream.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"!apt update\n",
"!apt install -y python3-openslide openslide-tools\n",
"!pip install 'large_image[openslide,tiff]' --find-links https://girder.github.io/large_image_wheels\n",
"!pip install histomics_stream\n",
"!pip install histomics_stream[torch]\n",
"\n",
"# Get other packages used in this notebook\n",
"# N.B. itkwidgets works with jupyter<=3.0.0\n",
Expand Down
2 changes: 1 addition & 1 deletion example/tensorflow_stream.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"!apt update\n",
"!apt install -y python3-openslide openslide-tools\n",
"!pip install 'large_image[openslide,tiff]' --find-links https://girder.github.io/large_image_wheels\n",
"!pip install histomics_stream\n",
"!pip install histomics_stream[tensorflow]\n",
"\n",
"# Get other packages used in this notebook\n",
"# N.B. itkwidgets works with jupyter<=3.0.0\n",
Expand Down

0 comments on commit 20cc0a0

Please sign in to comment.