project creation for release on pip

Author: willGuimont

.github/workflows/python-publish.yml

@@ -0,0 +1,44 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [ published ]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'  # Set your desired Python version
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build the package
+        run: python -m build
+
+      - name: Publish to TestPyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+#          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+#        run: python -m twine upload dist/*

.gitignore

@@ -1,2 +1,3 @@
 /venv/
+/.venv/
 /.idea/

README.md

@@ -1,3 +1,23 @@
 # Learnable Fourier Features for Multi-Dimensional Spatial Positional Encoding
 
 Implementation of [Learnable Fourier Features for Multi-Dimensional Spatial Positional Encoding](https://arxiv.org/abs/2106.02795) by Li, Si, Li, Hsieh and Bengio.
+
+## Installation
+
+```bash
+pip install learnable_fourier_positional_encoding
+```
+
+## Usage
+
+```python
+import torch
+from learnable_fourier_positional_encoding import LearnableFourierPositionalEncoding
+
+G = 3
+M = 17
+x = torch.randn((97, G, M))
+enc = LearnableFourierPositionalEncoding(G, M, 768, 32, 768, 10)
+pex = enc(x)
+print(pex.shape)
+```

pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "learnable_fourier_positional_encoding"
+version = "0.0.1"
+authors = [
+    { name = "William Guimont-Martin", email = "[email protected]" },
+]
+description = "Learnable Fourier Features for Multi-Dimensional Spatial Positional Encoding "
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.8"
+dependencies = ["numpy", "torch"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/willGuimont/learnable_fourier_positional_encoding"
+Issues = "https://github.com/willGuimont/learnable_fourier_positional_encoding/issues"

src/learnable_fourier_pos_encoding/__init__.py

@@ -0,0 +1,6 @@
+"""Learnable Fourier Features for Multi-Dimensional Spatial Positional Encoding """
+
+from .learnable_fourier_pos_encoding import LearnableFourierPositionalEncoding
+
+__all__ = ["LearnableFourierPositionalEncoding"]
+__version__ = '0.0.1'