torch-geopooling 1.2.0__cp312-cp312-manylinux_2_28_x86_64.whl

torch_geopooling/__bind__/python_module.cc

@@ -0,0 +1,28 @@
+#include <torch_geopooling/torch_geopooling.h>
+
+#include <pybind11/pybind11.h>
+#include <torch/extension.h>
+
+#include "python_tuples.h"
+
+
+namespace torch_geopooling {
+
+
+PYBIND11_MODULE(TORCH_EXTENSION_NAME, m)
+{
+    m.def("avg_quad_pool2d", &avg_quad_pool2d);
+    m.def("avg_quad_pool2d_backward", &avg_quad_pool2d_backward);
+
+    m.def("max_quad_pool2d", &max_quad_pool2d);
+    m.def("max_quad_pool2d_backward", &max_quad_pool2d_backward);
+
+    m.def("quad_pool2d", &quad_pool2d);
+    m.def("quad_pool2d_backward", &quad_pool2d_backward);
+
+    m.def("embedding2d", &embedding2d);
+    m.def("embedding2d_backward", &embedding2d_backward);
+}
+
+
+} // namespace torch_geopooling

torch_geopooling/__init__.py

@@ -0,0 +1,3 @@
+from typing import Final
+
+__version__: Final[str] = "1.2.0"

torch_geopooling/functional/__init__.py

@@ -0,0 +1,2 @@
+from torch_geopooling.functional.embedding import *  # noqa
+from torch_geopooling.functional.pooling import *  # noqa

torch_geopooling/functional/embedding.py

@@ -0,0 +1,92 @@
+# Copyright (C) 2024, Yakau Bubnou
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+from typing import Optional, Tuple
+
+from torch import Tensor, autograd
+from torch.autograd.function import FunctionCtx
+
+import torch_geopooling._C as _C
+from torch_geopooling.tiling import ExteriorTuple
+
+
+__all__ = ["embedding2d"]
+
+
+class Function(autograd.Function):
+    @staticmethod
+    def forward(
+        input: Tensor,
+        weight: Tensor,
+        padding: Tuple[int, int],
+        exterior: ExteriorTuple,
+        reflection: bool,
+    ) -> Tensor:
+        return _C.embedding2d(input, weight, padding, exterior, reflection)
+
+    @staticmethod
+    def setup_context(ctx: FunctionCtx, inputs: Tuple, outputs: Tuple) -> None:
+        input, weight, padding, exterior, reflection = inputs
+
+        ctx.save_for_backward(input, weight)
+        ctx.padding = padding
+        ctx.exterior = exterior
+        ctx.reflection = reflection
+
+    @staticmethod
+    def backward(ctx: FunctionCtx, grad: Tensor) -> Tuple[Optional[Tensor], ...]:
+        input, weight = ctx.saved_tensors
+        grad_weight = _C.embedding2d_backward(
+            grad, input, weight, ctx.padding, ctx.exterior, ctx.reflection
+        )
+        return None, grad_weight, None, None, None
+
+
+def embedding2d(
+    input: Tensor,
+    weight: Tensor,
+    *,
+    padding: Tuple[int, int] = (0, 0),
+    exterior: ExteriorTuple,
+    reflection: bool = True,
+) -> Tensor:
+    """
+    Retrieves spatial embeddings from a fixed-size lookup table based on 2D coordinates.
+
+    This function accepts a list of (x, y) coordinates and retrieves the corresponding
+    spatial embeddings from a provided embedding matrix. The embeddings are selected
+    based on the input coordinates, with an optional padding to include neighboring cells.
+    See :class:`torch_geopooling.nn.Embedding2d` for more details.
+
+    Args:
+        input: A list of 2D coordinates where each coordinate is represented as a tuple (x, y),
+            where x is the longitude and y is the latitude.
+        weight: A 3D tensor representing the embedding matrix. The first dimension  corresponds to
+            the maximum possible bucket for the x coordinate, the second dimension corresponds to
+            the maximum possible bucket for the y coordinate, and the third dimension corresponds
+            to the embedding size.
+        padding: The size of the neighborhood to query. Default is 0, meaning only the embedding
+            for the exact input coordinate is retrieved.
+        exterior: The geometric boundary of the learning space, specified as a tuple (X, Y, W, H),
+            where X and Y represent the origin, and W and H represent the width and height of the
+            space, respectively.
+        reflection: When true, kernel is wrapped around the exterior space, otherwise kernel is
+            squeezed into borders.
+
+    Returns:
+        Tensor: The retrieved spatial embeddings corresponding to the input coordinates.
+    """
+
+    return Function.apply(input, weight, padding, exterior, reflection)

torch_geopooling/functional/embedding_test.py

@@ -0,0 +1,32 @@
+# Copyright (C) 2024, Yakau Bubnou
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import torch
+from torch_geopooling.functional.embedding import embedding2d
+
+
+def test_embedding2d() -> None:
+    input = torch.rand((100, 2), dtype=torch.float64) * 10.0
+    weight = torch.rand((1024, 1024, 3), dtype=torch.float64)
+
+    result = embedding2d(
+        input,
+        weight,
+        padding=(3, 2),
+        exterior=(-10.0, -10.0, 20.0, 20.0),
+        reflection=True,
+    )
+
+    assert result.size() == torch.Size([100, 7, 5, 3])

torch_geopooling/functional/pooling.py

@@ -0,0 +1,354 @@
+# Copyright (C) 2024, Yakau Bubnou
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+from textwrap import dedent, indent
+from functools import partial
+from inspect import signature
+from typing import Callable, NamedTuple, Optional, Tuple
+
+import torch
+from torch import Tensor, autograd
+from torch.autograd.function import FunctionCtx
+
+import torch_geopooling._C as _C
+from torch_geopooling import return_types
+from torch_geopooling.tiling import ExteriorTuple
+
+__all__ = [
+    "adaptive_avg_quad_pool2d",
+    "adaptive_max_quad_pool2d",
+    "adaptive_quad_pool2d",
+    "avg_quad_pool2d",
+    "max_quad_pool2d",
+    "quad_pool2d",
+]
+
+
+def __def__(fn: Callable, doc: str) -> Callable:
+    f = partial(fn)
+    f.__doc__ = doc + indent(dedent(fn.__doc__ or ""), "    ")
+    f.__module__ = fn.__module__
+    f.__annotations__ = fn.__annotations__
+    f.__signature__ = signature(fn)  # type: ignore
+    f.__defaults__ = fn.__defaults__  # type: ignore
+    f.__kwdefaults__ = fn.__kwdefaults__  # type: ignore
+    return f
+
+
+class FunctionParams(NamedTuple):
+    max_terminal_nodes: Optional[int] = None
+    max_depth: Optional[int] = None
+    capacity: Optional[int] = None
+    precision: Optional[int] = None
+
+
+ForwardType = Callable[
+    [
+        Tensor,  # tiles
+        Tensor,  # weight
+        Tensor,  # input
+        ExteriorTuple,  # exterior
+        bool,  # training
+        Optional[int],  # max_terminal_nodes
+        Optional[int],  # max_depth
+        Optional[int],  # capacity
+        Optional[int],  # precision
+    ],
+    Tuple[Tensor, Tensor, Tensor],  # (tiles, weight, values)
+]
+
+
+BackwardType = Callable[
+    [
+        Tensor,  # grad_output
+        Tensor,  # tiles
+        Tensor,  # weight
+        Tensor,  # input
+        ExteriorTuple,  # exterior
+        Optional[int],  # max_terminal_nodes
+        Optional[int],  # max_depth
+        Optional[int],  # capacity
+        Optional[int],  # precision
+    ],
+    Tensor,  # (grad_weight)
+]
+
+
+class Function(autograd.Function):
+    forward_impl: ForwardType
+    backward_impl: BackwardType
+
+    @classmethod
+    def forward(
+        cls,
+        tiles: Tensor,
+        weight: Tensor,
+        input: Tensor,
+        exterior: ExteriorTuple,
+        training: bool,
+        params: FunctionParams,
+    ) -> Tuple[Tensor, Tensor, Tensor]:
+        return cls.forward_impl(tiles, weight, input, exterior, training, *params)
+
+    @staticmethod
+    def setup_context(ctx: FunctionCtx, inputs: Tuple, outputs: Tuple) -> None:
+        _, _, input, exterior, _, params = inputs
+        tiles, weight, _ = outputs
+
+        ctx.save_for_backward(tiles.view_as(tiles), weight.view_as(weight), input.view_as(input))
+        ctx.exterior = exterior
+        ctx.params = params
+
+    @classmethod
+    def backward(
+        cls, ctx: FunctionCtx, grad_tiles: Tensor, grad_weight: Tensor, grad_values: Tensor
+    ) -> Tuple[Optional[Tensor], ...]:
+        grad_weight_out = cls.backward_impl(
+            grad_values, *ctx.saved_tensors, ctx.exterior, *ctx.params
+        )  # type: ignore
+        # Drop gradient for tiles, this should not be changed by an optimizer.
+        return None, grad_weight_out, None, None, None, None
+
+    @classmethod
+    def func(
+        cls,
+        tiles: Tensor,
+        weight: Tensor,
+        input: Tensor,
+        exterior: Tuple[float, ...],
+        *,
+        training: bool = True,
+        max_terminal_nodes: Optional[int] = None,
+        max_depth: Optional[int] = None,
+        capacity: Optional[int] = None,
+        precision: Optional[int] = None,
+    ) -> return_types.quad_pool2d:
+        """
+        Args:
+            tiles: Tiles tensor representing tiles of a quadtree (both, internal and terminal).
+            weight: Weights tensor associated with each tile of a quadtree.
+            input: Input 2D coordinates as pairs of x (longitude) and y (latitude).
+            exterior: Geometrical boundary of the learning space in (X, Y, W, H) format.
+            training: True, when executed during training, and False otherwise.
+            max_terminal_nodes: Optional maximum number of terminal nodes in a quadtree. Once a
+                maximum is reached, internal nodes are no longer sub-divided and tree stops
+                growing.
+            max_depth: Maximum depth of the quadtree. Default: 17.
+            capacity: Maximum number of inputs, after which a quadtree's node is subdivided and
+                depth of the tree grows. Default: 1.
+            precision: Optional rounding of the input coordinates. Default: 7.
+        """
+        params = FunctionParams(
+            max_terminal_nodes=max_terminal_nodes,
+            max_depth=max_depth,
+            capacity=capacity,
+            precision=precision,
+        )
+
+        result = cls.apply(tiles, weight, input, exterior, training, params)
+        return return_types.quad_pool2d(*result)
+
+
+class QuadPool2d(Function):
+    forward_impl = _C.quad_pool2d
+    backward_impl = _C.quad_pool2d_backward
+
+
+class MaxQuadPool2d(Function):
+    forward_impl = _C.max_quad_pool2d
+    backward_impl = _C.max_quad_pool2d_backward
+
+
+class AvgQuadPool2d(Function):
+    forward_impl = _C.avg_quad_pool2d
+    backward_impl = _C.avg_quad_pool2d_backward
+
+
+quad_pool2d = __def__(
+    QuadPool2d.func,
+    """Lookup index over quadtree decomposition of input 2D coordinates.
+
+    See :class:`torch_geopooling.nn.QuadPool2d` for more details.
+    """,
+)
+max_quad_pool2d = __def__(
+    MaxQuadPool2d.func,
+    """Maximum pooling over quadtree decomposition of input 2D coordinates.
+
+    See :class:`torch_geopooling.nn.MaxQuadPool2d` for more details.
+    """,
+)
+avg_quad_pool2d = __def__(
+    AvgQuadPool2d.func,
+    """Average pooling over quadtree decomposition of input 2D coordinates.
+
+    See :class:`torch_geopooling.nn.AvgQuadPool2d` for more details.
+    """,
+)
+
+
+class AdaptiveFunction(autograd.Function):
+    forward_impl: ForwardType
+    backward_impl: BackwardType
+
+    @staticmethod
+    def sparse_ravel(weight: Tensor) -> Tuple[Tensor, Tensor]:
+        """Transform weight as coordinate sparse tensor into a tuple of tiles and feature tensor.
+
+        The method transforms sparse encoding of quadtree (where 3 first dimensions are
+        coordinates of a tile and 4-th dimension is an index of a feature in the feature
+        vector), into tuple of coordinates (tiles) and dense weight tensor.
+
+        Effectively: (17,131072,131702,5) -> (nnz,3), (nnz,5); where nnz - is a number of
+        non-zero elements in the sparse tensor.
+        """
+        feature_dim = weight.size(-1)
+        weight = weight.coalesce()
+
+        # Transform sparse tensor into a tuple of (tiles, weight) that are directly usable
+        # by the C++ extension functions.
+        tiles = weight.indices().t()[::feature_dim, :-1]
+        w = weight.values().reshape((-1, feature_dim))
+        return tiles, w
+
+    @staticmethod
+    def sparse_unravel(tiles: Tensor, weight: Tensor, size: torch.Size) -> Tensor:
+        """Perform inverse operation of `ravel`.
+
+        Method packs tiles (coordinates) and weight (values) into a coordinate sparse tensor.
+        """
+        feature_dim = weight.size(-1)
+        feature_indices = torch.arange(0, feature_dim).repeat(tiles.size(0))
+
+        indices = tiles.repeat_interleave(feature_dim, dim=0)
+        indices = torch.column_stack((indices, feature_indices))
+
+        return torch.sparse_coo_tensor(indices.t(), weight.ravel(), size=size)
+
+    @classmethod
+    def forward(
+        cls,
+        weight: Tensor,
+        input: Tensor,
+        exterior: ExteriorTuple,
+        training: bool,
+        params: FunctionParams,
+    ) -> Tuple[Tensor, Tensor]:
+        tiles, w = cls.sparse_ravel(weight)
+
+        tiles_out, w_out, values_out = cls.forward_impl(
+            tiles, w, input, exterior, training, *params
+        )
+
+        weight_out = cls.sparse_unravel(tiles_out, w_out, size=weight.size())
+        return weight_out.coalesce(), values_out
+
+    @staticmethod
+    def setup_context(ctx: FunctionCtx, inputs: Tuple, outputs: Tuple) -> None:
+        _, input, exterior, _, params = inputs
+        weight, _ = outputs
+
+        ctx.save_for_backward(weight, input)
+        ctx.exterior = exterior
+        ctx.params = params
+
+    @classmethod
+    def backward(
+        cls, ctx: FunctionCtx, grad_weight: Tensor, grad_values: Tensor
+    ) -> Tuple[Optional[Tensor], ...]:
+        weight, input = ctx.saved_tensors
+        tiles, w = cls.sparse_ravel(weight)
+
+        grad_weight_dense = cls.backward_impl(
+            grad_values, tiles, w, input, ctx.exterior, *ctx.params
+        )  # type: ignore
+        grad_weight_sparse = cls.sparse_unravel(tiles, grad_weight_dense, size=weight.size())
+
+        return grad_weight_sparse.coalesce(), None, None, None, None
+
+    @classmethod
+    def func(
+        cls,
+        weight: Tensor,
+        input: Tensor,
+        exterior: Tuple[float, ...],
+        *,
+        training: bool = True,
+        max_terminal_nodes: Optional[int] = None,
+        max_depth: Optional[int] = None,
+        capacity: Optional[int] = None,
+        precision: Optional[int] = None,
+    ) -> return_types.adaptive_quad_pool2d:
+        """
+        Args:
+            weight: Weights tensor associated with each tile of a quadtree.
+            input: Input 2D coordinates as pairs of x (longitude) and y (latitude).
+            exterior: Geometrical boundary of the learning space in (X, Y, W, H) format.
+            training: True, when executed during training, and False otherwise.
+            max_terminal_nodes: Optional maximum number of terminal nodes in a quadtree. Once a
+                maximum is reached, internal nodes are no longer sub-divided and tree stops
+                growing.
+            max_depth: Maximum depth of the quadtree. Default: 17.
+            capacity: Maximum number of inputs, after which a quadtree's node is subdivided and
+                depth of the tree grows. Default: 1.
+            precision: Optional rounding of the input coordinates. Default: 7.
+        """
+        params = FunctionParams(
+            max_terminal_nodes=max_terminal_nodes,
+            max_depth=max_depth,
+            capacity=capacity,
+            precision=precision,
+        )
+
+        result = cls.apply(weight, input, exterior, training, params)
+        return return_types.adaptive_quad_pool2d(*result)
+
+
+class AdaptiveQuadPool2d(AdaptiveFunction):
+    forward_impl = _C.quad_pool2d
+    backward_impl = _C.quad_pool2d_backward
+
+
+class AdaptiveMaxQuadPool2d(AdaptiveFunction):
+    forward_impl = _C.max_quad_pool2d
+    backward_impl = _C.max_quad_pool2d_backward
+
+
+class AdaptiveAvgQuadPool2d(AdaptiveFunction):
+    forward_impl = _C.avg_quad_pool2d
+    backward_impl = _C.avg_quad_pool2d_backward
+
+
+adaptive_quad_pool2d = __def__(
+    AdaptiveQuadPool2d.func,
+    """Adaptive lookup index over quadtree decomposition of input 2D coordinates.
+
+    See :class:`torch_geopooling.nn.AdaptiveQuadPool2d` for more details.
+    """,
+)
+adaptive_max_quad_pool2d = __def__(
+    AdaptiveMaxQuadPool2d.func,
+    """Adaptive maximum pooling over quadtree decomposition of input 2D coordinates.
+
+    See :class:`torch_geopooling.nn.AdaptiveMaxQuadPool2d` for more details.
+    """,
+)
+adaptive_avg_quad_pool2d = __def__(
+    AdaptiveAvgQuadPool2d.func,
+    """Adaptive average pooling over quadtree decomposition of input 2D coordinates.
+
+    See :class:`torch_geopooling.nn.AdaptiveAvgQuadPool2d` for more details.
+    """,
+)

torch_geopooling/functional/pooling_test.py

@@ -0,0 +1,100 @@
+# Copyright (C) 2024, Yakau Bubnou
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+import pytest
+import torch
+
+from torch_geopooling.functional.pooling import (
+    AdaptiveFunction,
+    adaptive_quad_pool2d,
+    adaptive_avg_quad_pool2d,
+    adaptive_max_quad_pool2d,
+    avg_quad_pool2d,
+    max_quad_pool2d,
+    quad_pool2d,
+)
+
+
+def test_adaptive_function_ravel() -> None:
+    size = (2, 2, 2, 1)
+    tiles = torch.tensor([[0, 0, 0], [1, 0, 0], [1, 0, 1], [1, 1, 0], [1, 1, 1]], dtype=torch.int64)
+
+    weight = torch.tensor([[1.0], [2.0], [3.0], [4.0], [5.0]], dtype=torch.float64)
+
+    sparse = AdaptiveFunction.sparse_unravel(tiles, weight, size=size)
+    torch.testing.assert_close(sparse.to_dense().to_sparse_coo(), sparse)
+
+    tiles_out, weight_out = AdaptiveFunction.sparse_ravel(sparse)
+    torch.testing.assert_close(tiles_out, tiles)
+    torch.testing.assert_close(weight_out, weight)
+
+
+@pytest.mark.parametrize(
+    "function",
+    [
+        quad_pool2d,
+        max_quad_pool2d,
+        avg_quad_pool2d,
+    ],
+    ids=["id", "max", "avg"],
+)
+def test_quad_pool2d(function) -> None:
+    tiles = torch.empty((0, 3), dtype=torch.int64)
+    input = torch.rand((100, 2), dtype=torch.float64) * 10.0
+    weight = torch.randn([0, 5], dtype=torch.float64)
+
+    result = function(
+        tiles,
+        weight,
+        input,
+        (0.0, 0.0, 10.0, 10.0),
+        training=True,
+        max_depth=16,
+        capacity=1,
+        precision=6,
+    )
+    assert result.tiles.size(0) > 0
+    assert result.tiles.size(1) == 3
+
+    assert result.weight.size(0) == result.tiles.size(0)
+    assert result.values.size() == torch.Size([input.size(0), weight.size(1)])
+
+
+@pytest.mark.parametrize(
+    "function",
+    [
+        adaptive_quad_pool2d,
+        adaptive_max_quad_pool2d,
+        adaptive_avg_quad_pool2d,
+    ],
+    ids=["id", "max", "avg"],
+)
+def test_adaptive_quad_pool2d(function) -> None:
+    input = torch.rand((100, 2), dtype=torch.float64) * 10.0
+    weight = torch.sparse_coo_tensor(size=(10, 1 << 10, 1 << 10, 4), dtype=torch.float64)
+
+    result = function(
+        weight,
+        input,
+        (0.0, 0.0, 10.0, 10.0),
+        training=True,
+        max_depth=16,
+        capacity=1,
+        precision=6,
+    )
+
+    assert result.weight.layout == torch.sparse_coo
+    assert result.weight.indices().size(0) > 0
+    assert result.values.size() == torch.Size([input.size(0), weight.size(-1)])

torch_geopooling/nn/__init__.py

@@ -0,0 +1,2 @@
+from torch_geopooling.nn.embedding import *  # noqa
+from torch_geopooling.nn.pooling import *  # noqa