torch-geopooling 1.1.0__cp311-cp311-macosx_11_0_arm64.whl → 1.1.2__cp311-cp311-macosx_11_0_arm64.whl

torch_geopooling/__init__.py

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

torch_geopooling/functional/embedding.py

@@ -32,22 +32,26 @@ class Function(autograd.Function):
         weight: Tensor,
         padding: Tuple[int, int],
         exterior: ExteriorTuple,
+        reflection: bool,
     ) -> Tensor:
-        return _C.embedding2d(input, weight, padding, exterior)
+        return _C.embedding2d(input, weight, padding, exterior, reflection)
 
     @staticmethod
     def setup_context(ctx: FunctionCtx, inputs: Tuple, outputs: Tuple) -> None:
-        input, weight, padding, exterior = inputs
+        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)
-        return None, grad_weight, None, None
+        grad_weight = _C.embedding2d_backward(
+            grad, input, weight, ctx.padding, ctx.exterior, ctx.reflection
+        )
+        return None, grad_weight, None, None, None
 
 
 def embedding2d(
@@ -56,6 +60,7 @@ def embedding2d(
     *,
     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.
@@ -77,9 +82,11 @@ def embedding2d(
         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)
+    return Function.apply(input, weight, padding, exterior, reflection)

torch_geopooling/functional/embedding_test.py

@@ -26,6 +26,7 @@ def test_embedding2d() -> None:
         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/nn/embedding.py

@@ -46,6 +46,8 @@ class Embedding2d(nn.Module):
         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.
 
     Shape:
         - Input: :math:`(*, 2)`, where 2 comprises x and y coordinates.
@@ -74,16 +76,27 @@ class Embedding2d(nn.Module):
         manifold: Tuple[int, int, int],
         exterior: _Exterior,
         padding: Tuple[int, int] = (0, 0),
+        reflection: bool = True,
     ) -> None:
         super().__init__()
+        self.manifold = manifold
         self.exterior = cast(ExteriorTuple, tuple(map(float, exterior)))
         self.padding = padding
+        self.reflection = reflection
 
         self.weight = nn.Parameter(torch.empty(manifold, dtype=torch.float64))
         nn.init.zeros_(self.weight)
 
     def extra_repr(self) -> str:
-        return "{manifold}, exterior={exterior}, padding={padding}".format(**self.__dict__)
+        return "{manifold}, exterior={exterior}, padding={padding}, reflection={reflection}".format(
+            **self.__dict__
+        )
 
     def forward(self, input: Tensor) -> Tensor:
-        return F.embedding2d(input, self.weight, exterior=self.exterior, padding=self.padding)
+        return F.embedding2d(
+            input,
+            self.weight,
+            exterior=self.exterior,
+            padding=self.padding,
+            reflection=self.reflection,
+        )

{torch_geopooling-1.1.0.dist-info → torch_geopooling-1.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: torch-geopooling
-Version: 1.1.0
+Version: 1.1.2
 Summary: The geospatial pooling modules for neural networks in PyTorch
 Author-email: Yakau Bubnou <girokompass@gmail.com>
 License: GNU GENERAL PUBLIC LICENSE
@@ -768,6 +768,16 @@ input = torch.DoubleTensor(200, 2).uniform_(0.0, 10.0)
 output = pool(input)
 ```
 
+Using 2-dimensional embedding module for learning data on sphere:
+```py
+import torch
+from torch_geopooling.nn import Embedding2d
+
+embedding = Embedding2d((16, 16, 2), padding=(3, 3), exterior=(-100, 100, 200.0, 200.0))
+input = torch.DoubleTensor(1024, 2).normal_(5.0, 1.0)
+output = embedding(input)
+```
+
 ## License
 
 The Torch Geopooling is distributed under GPLv3 license. See the [LICENSE](LICENSE) file for full

{torch_geopooling-1.1.0.dist-info → torch_geopooling-1.1.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
-torch_geopooling/_C.cpython-311-darwin.so,sha256=_vrttV27rZTnBjQf-DHvPscuBHVWpr0POZml9T3UW_g,562392
-torch_geopooling/__init__.py,sha256=0o5Lnb5ZcEIRNY9AljwW1ESEmQid79rcbBsDBoMT8aM,60
+torch_geopooling/_C.cpython-311-darwin.so,sha256=4dmm-djuX1uKe5goERvZS5BR1BWJJTmHEngBTYXvuuI,562456
+torch_geopooling/__init__.py,sha256=W3RCgJbj6HbE-qg2_ltJFtMf9KboKmOCMEZfS4eEQOI,60
 torch_geopooling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 torch_geopooling/return_types.py,sha256=QhIKf_qxpppzuZzUrT-VacfbvZ6zKmSRu-WZOqL8wuE,898
 torch_geopooling/tiling.py,sha256=f1g0Gf__5zIOafZzDkwO62t9OqMDMBEYVtM2HXB5X0Y,2553
@@ -7,18 +7,18 @@ torch_geopooling/transforms.py,sha256=NHPBgx1L4-1745xNO_PvLuvbMH6DWi2rs1ViuRyBQA
 torch_geopooling/transforms_test.py,sha256=Cqp4VVObBVrc8HQ7uxkpe1EsQ5NxXrCI77BiUqngLXw,1196
 torch_geopooling/__bind__/python_module.cc,sha256=LLI363riung_4LI5ugN7Pm93iuoHDRF7n4Y4RlkzLYk,675
 torch_geopooling/functional/__init__.py,sha256=BCcS22yPWITm37M-EPD-PK6WrS7grikDR8uZdoO8sZ4,118
-torch_geopooling/functional/embedding.py,sha256=ER0KB-G7SoCsWJuNEqXRC_XcLdhqaCpn5OJPpUF9pLc,3337
-torch_geopooling/functional/embedding_test.py,sha256=B5a1MP0rynX01a1RmmTJHZxMi4Y68cQoblw-kQawHJM,1094
+torch_geopooling/functional/embedding.py,sha256=Pd01LuVhrDVRb35_7YaJwmdPeCYSZ1fzvvV7NZ03BR8,3639
+torch_geopooling/functional/embedding_test.py,sha256=n844pekbw01I1WtAMsRfvlw4nFSBTrPNjMtRrUPd1ZY,1119
 torch_geopooling/functional/pooling.py,sha256=MuJfPW_RC4slgzWBO2ngQIBTzlZXeW7DBqV3ooIOSw4,12060
 torch_geopooling/functional/pooling_test.py,sha256=qBT_WVbwyANolwg7-rE7KimF-bAEDB44guBl4OQuQhE,3005
 torch_geopooling/nn/__init__.py,sha256=fWrhfQu0_KzW7VUesk31Sy3n3Om2c5g5dGA3vrLcCg4,102
-torch_geopooling/nn/embedding.py,sha256=u0H1e_sqFG8ALmnfLpbFwKr_yw-z7MNExmB9-uE0SF0,3317
+torch_geopooling/nn/embedding.py,sha256=MD8oTH2IP2g368NVZJoxcXqND-pQ1gXDMvt9F31rMbk,3697
 torch_geopooling/nn/embedding_test.py,sha256=msUeidL9Xkf3AKCPGQH9SJAhfkS7dyqYRzsH88Pt1uY,1505
 torch_geopooling/nn/pooling.py,sha256=_NnGB45dWTZy4MQokFfmJL3as-EPVU3liwOuAmWbv1Y,14219
 torch_geopooling/nn/pooling_test.py,sha256=AqnkpaQ6LcQxh5bWkuDuBAJ2XiBc-C2zVuUp5hynzBM,4794
-torch_geopooling-1.1.0.dist-info/LICENSE,sha256=jLc4eyvG8hqxH4AdKAjK2DwXoP68qjHiGfq8eP5ubBI,35069
-torch_geopooling-1.1.0.dist-info/METADATA,sha256=SnR-sEl9o7dGaskBb2gk0CNU6AydBsta4ZcxFSpuFu8,44371
-torch_geopooling-1.1.0.dist-info/WHEEL,sha256=LFVzND6nAdWMS-norKkn42oL86bk-j1PiLvh1xzptX0,110
-torch_geopooling-1.1.0.dist-info/dependency_links.txt,sha256=JqLDcYHtEaQB51V72n3gAJvRd36bpoPk9qgTbot-Lx4,37
-torch_geopooling-1.1.0.dist-info/top_level.txt,sha256=3geTL2nsLvybdtr1psWIE6h63B1LuyIIyWWv0rDafTk,17
-torch_geopooling-1.1.0.dist-info/RECORD,,
+torch_geopooling-1.1.2.dist-info/LICENSE,sha256=jLc4eyvG8hqxH4AdKAjK2DwXoP68qjHiGfq8eP5ubBI,35069
+torch_geopooling-1.1.2.dist-info/METADATA,sha256=XkmsKm7tWfdkK4HOKA8fwh04XcbkkjbIgzmXQA2JVAE,44675
+torch_geopooling-1.1.2.dist-info/WHEEL,sha256=LFVzND6nAdWMS-norKkn42oL86bk-j1PiLvh1xzptX0,110
+torch_geopooling-1.1.2.dist-info/dependency_links.txt,sha256=JqLDcYHtEaQB51V72n3gAJvRd36bpoPk9qgTbot-Lx4,37
+torch_geopooling-1.1.2.dist-info/top_level.txt,sha256=3geTL2nsLvybdtr1psWIE6h63B1LuyIIyWWv0rDafTk,17
+torch_geopooling-1.1.2.dist-info/RECORD,,