Skip to content

Commit e22c1e1

Browse files
committed
Updated docstrings
1 parent 26a5fbe commit e22c1e1

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

sopa/io/reader/wsi.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313
def wsi(
1414
path: str | Path,
1515
as_image: bool = False,
16-
backend: Literal["tiffslide", "openslide"] = "tiffslide",
16+
backend: Literal["tiffslide", "openslide", "slideio"] = "tiffslide",
1717
) -> SpatialData | DataTree:
1818
"""Read a WSI into a `SpatialData` object
1919
2020
Args:
2121
path: Path to the WSI
2222
chunks: Tuple representing the chunksize for the dimensions `(C, Y, X)`.
2323
as_image: If `True`, returns a, image instead of a `SpatialData` object
24-
backend: The library to use as a backend in order to load the WSI. One of: `"openslide"`, `"tiffslide"`.
24+
backend: The library to use as a backend in order to load the WSI. One of: `"openslide"`, `"tiffslide"`, `"slideio"`.
2525
2626
Returns:
2727
A `SpatialData` object with a multiscale 2D-image of shape `(C, Y, X)`, or just the DataTree if `as_image=True`
@@ -70,7 +70,7 @@ def _get_scale_transformation(scale_factor: float):
7070
def wsi_autoscale(
7171
path: str | Path,
7272
image_model_kwargs: dict | None = None,
73-
backend: Literal["tiffslide", "openslide"] = "tiffslide",
73+
backend: Literal["tiffslide", "openslide", "slideio"] = "tiffslide",
7474
) -> SpatialData:
7575
"""Read a WSI into a `SpatialData` object.
7676
@@ -80,7 +80,7 @@ def wsi_autoscale(
8080
Args:
8181
path: Path to the WSI
8282
image_model_kwargs: Kwargs provided to the `Image2DModel`
83-
backend: The library to use as a backend in order to load the WSI. One of: `"openslide"`, `"tiffslide"`.
83+
backend: The library to use as a backend in order to load the WSI. One of: `"openslide"`, `"tiffslide"`, `"slideio"`.
8484
8585
Returns:
8686
A `SpatialData` object with a 2D-image of shape `(C, Y, X)`

sopa/patches/infer.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ def compute_embeddings(
5050
image_key: Optional image key of the image, unecessary if there is only one image.
5151
batch_size: Mini-batch size used during inference.
5252
device: Device used for the computer vision model.
53+
data_parallel: If `True`, the model will be run in data parallel mode. If a list of GPUs is provided, the model will be run in data parallel mode on the specified GPUs.
5354
key_added: Optional name of the spatial element that will be added (storing the embeddings).
5455
"""
5556
try:

0 commit comments

Comments
 (0)