diff --git a/patchly/__init__.py b/patchly/__init__.py index bd45c26..290b9e2 100644 --- a/patchly/__init__.py +++ b/patchly/__init__.py @@ -1,4 +1,4 @@ -__version__ = "0.0.11" +__version__ = "0.0.12" from patchly.sampler import GridSampler, SamplingMode from patchly.aggregator import Aggregator diff --git a/patchly/aggregator.py b/patchly/aggregator.py index 382cba3..58bdb9c 100644 --- a/patchly/aggregator.py +++ b/patchly/aggregator.py @@ -29,6 +29,8 @@ def __init__(self, sampler: GridSampler, output_size: Optional[Union[Tuple, npt. """ Initializes the Aggregator object for aggregating patches into a larger output image. + A complete overview of how the Sampler and Aggregator work and an in-depth explanation of the features can be found in OVERVIEW.md. + :param sampler: GridSampler - The sampler used to sample patches from the input image. :param output_size: Optional[Union[Tuple, npt.ArrayLike]] - The size of the output image. Can be None if output is provided. :param output: Optional[npt.ArrayLike] - The array to store the aggregated output. Can be None if output_size is provided. @@ -215,6 +217,8 @@ def __init__(self, sampler: GridSampler, image_size_s: Union[Tuple, npt.ArrayLik """ Initializes the _Aggregator object, a private class for handling patch aggregation. + A complete overview of how the Sampler and Aggregator work and an in-depth explanation of the features can be found in OVERVIEW.md. + :param sampler: GridSampler - The sampler used to generate patches. :param image_size_s: Union[Tuple, npt.ArrayLike] - The size of the image in spatial dimensions. :param patch_size_s: Union[Tuple, npt.ArrayLike] - The size of each patch in spatial dimensions. @@ -353,6 +357,8 @@ def __init__(self, sampler: GridSampler, image_size_s: Union[Tuple, npt.ArrayLik """ Initializes the _ChunkAggregator object, a subclass of _Aggregator, for managing patch aggregation in chunks. + A complete overview of how the Sampler and Aggregator work and an in-depth explanation of the features can be found in OVERVIEW.md. + :param sampler: GridSampler - The sampler used for generating patches. :param image_size_s: Union[Tuple, npt.ArrayLike] - The size of the image in spatial dimensions. :param patch_size_s: Union[Tuple, npt.ArrayLike] - The size of each patch in spatial dimensions.