Guide about Embedding2d (#80)

This patch adds guide about the spatial embedding module.
ybubnov · Aug 23, 2024 · 0096c67 · 0096c67
1 parent 5640459
commit 0096c67
Show file tree

Hide file tree

Showing 5 changed files with 440 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -61,6 +61,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

diff --git a/docs/guide/getting_started.ipynb b/docs/guide/getting_started.ipynb
diff --git a/docs/guide/index.rst b/docs/guide/index.rst
@@ -10,6 +10,7 @@ assumed that a reader knows fundamentals of the `PyTorch`_ library.
    getting_started.ipynb
    house_prices.ipynb
    pooling_polygons.ipynb
+   spatial_embedding.ipynb
 
 
 .. _PyTorch: https://pytorch.org/tutorials/beginner/basics/intro.html
diff --git a/docs/guide/spatial_embedding.ipynb b/docs/guide/spatial_embedding.ipynb
diff --git a/torch_geopooling/nn/embedding.py b/torch_geopooling/nn/embedding.py
@@ -76,6 +76,7 @@ def __init__(
         padding: Tuple[int, int] = (0, 0),
     ) -> None:
         super().__init__()
+        self.manifold = manifold
         self.exterior = cast(ExteriorTuple, tuple(map(float, exterior)))
         self.padding = padding