torchcurves 0.1.0__tar.gz

torchcurves-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,52 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install build dependencies
+        run: |
+          uv venv
+          uv sync --all-groups
+
+      - name: Build package
+        run: |
+          uv build
+
+      - name: Archive package
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheel_and_source_${{ matrix.python-version }}
+          path: |
+            dist
+
+      - name: Build documentation
+        run: |
+          sudo apt-get -qq update
+          sudo apt-get install -y pandoc
+          cd doc
+          make html
+
+      - name: Archive documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs_${{ matrix.python-version }}
+          path: |
+            doc/build/html

torchcurves-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,44 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        uv venv
+        uv sync --all-groups
+
+    - name: Lint with ruff
+      run: |
+        uv run ruff check src/ tests/
+
+    - name: Format with black
+      run: |
+        uv run black --check --line-length 120 src/ tests/
+
+    - name: Type check with mypy
+      run: |
+        uv run mypy src/
+
+    - name: Test with pytest
+      run: |
+        uv run pytest tests/ -v --cov=torch_bspline --cov-report=term-missing

torchcurves-0.1.0/.gitignore

@@ -0,0 +1,65 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Testing
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Documentation
+docs/_build/
+docs/_static/
+docs/_templates/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# UV
+.python-version
+.ruff_cache
+
+# Sphinx
+doc/source/generated

torchcurves-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.9.3
+  hooks:
+    # Run the linter.
+    - id: ruff
+      types_or: [ python, pyi ]
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+      types_or: [ python, pyi ]
+- repo: https://github.com/astral-sh/uv-pre-commit
+  rev: 0.5.25
+  hooks:
+    - id: uv-lock

torchcurves-0.1.0/.readthedocs.yaml

@@ -0,0 +1,25 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+   os: ubuntu-24.04
+   tools:
+      python: "3.13"
+   apt_packages:
+      - pandoc
+   jobs:
+      pre_create_environment:
+         - asdf plugin add uv
+         - asdf install uv latest
+         - asdf global uv latest
+      create_environment:
+         - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+      install:
+         - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --all-groups
+
+sphinx:
+   configuration: doc/source/conf.py

torchcurves-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

torchcurves-0.1.0/PKG-INFO

@@ -0,0 +1,289 @@
+Metadata-Version: 2.4
+Name: torchcurves
+Version: 0.1.0
+Summary: PyTorch module for differentiable parametric curves with learnable coefficients
+Project-URL: Homepage, https://github.com/alexshtf/torchcurves
+Project-URL: Repository, https://github.com/alexshtf/torchcurves
+Project-URL: Issues, https://github.com/alexshtf/torchcurves/issues
+Author-email: Alex Shtoff <alex.shtf@gmail.com>
+License: Apache 2.0
+License-File: LICENSE
+Keywords: bspline,curves,deep-learning,differentiable,geometric-deep-learning,pytorch
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.9
+Requires-Dist: torch>=1.10.0
+Description-Content-Type: text/markdown
+
+# torchcurves
+
+![logo](logo.png)
+
+A PyTorch module for differentiable parametric curves with learnable coefficients,
+such as a B-Spline curve with learnable control points.
+
+This package provides fully differentiable curve implementations that integrate
+seamlessly with PyTorch's autograd system. It streamlines use cases such as
+continuous numerical embeddings for factorization machines [6] or transformers
+[2,3], Kolmogorov-Arnold networks [1], or path planning in robotics.
+
+Full documentation is available at
+[torchcurves.readthedocs.io](https://torchcurves.readthedocs.io/en/latest/).
+
+## Features
+
+- **Fully Differentiable**: Custom autograd function ensures gradients flow
+  properly through the curve evaluation.
+- **Batch Processing**: Vectorized operations for efficient batch evaluation.
+
+## Installation
+
+```bash
+pip install torchcurves
+```
+
+```bash
+uv add torchcurves
+```
+
+## Use cases
+
+There are examples in the `examples` directory showing how to build models using
+this library. Here we show some simple code snippets to appreciate the library.
+
+## Use case 1 - continuous embeddings
+
+```python
+import torchcurves as tc
+from torch import nn
+import torch
+
+
+def Net(nn.Module):
+    def __init__(self, num_categorical, num_numerical, dim, num_knots=10):
+        super().__init__()
+        self.cat_emb = nn.Embedding(num_categorical, dim)
+        self.num_emb = tc.BSplineEmbeddings(num_numerical, dim, knots_config=num_knots)
+        self.my_super_duper_transformer = MySuperDuperTransformer()
+
+    def forward(self, x_categorical, x_numerical):
+        embeddings = torch.cat([self.cat_emb(x_categorical), self.num_emb(x_numerical)], axis=-2)
+        return self.my_super_duper_transformer(embeddings)
+```
+
+## Use case 2 - Kolmogorov-Arnold networks
+
+A KAN [1] based on the B-Spline basis, along the lines of the original paper:
+
+```python
+import torchcurves as tc
+from torch import nn
+
+input_dim = 2
+intermediate_dim = 5
+num_control_points = 10
+
+kan = nn.Sequential(
+    # layer 1
+    tc.BSplineCurve(input_dim, intermediate_dim, knots_config=num_control_points),
+    tc.Sum(dim=-2),
+    # layer 2
+    tc.BSplineCurve(intermediate_dim, intermediate_dim, knots_config=num_control_points),
+    tc.Sum(dim=-2),
+    # layer 3
+    tc.BSplineCurve(intermediate_dim, 1, knots_config=num_control_points),
+    tc.Sum(dim=-2),
+)
+```
+Yes, we know the original KAN paper used a different curve parametrization,
+B-Spline + arcsinh, but the whole point of this repo is showing that KAN
+activations can be parametrized in arbitrary ways.
+
+For example, here is a KAN based on Legendre polynomials of degree 5:
+
+```python
+import torchcurves as tc
+from torch import nn
+
+input_dim = 2
+intermediate_dim = 5
+degree = 5
+
+kan = nn.Sequential(
+    # layer 1
+    tc.LegendreCurve(input_dim, intermediate_dim, degree=degree),
+    tc.Sum(dim=-2),
+    # layer 2
+    tc.LegendreCurve(intermediate_dim, intermediate_dim, degree=degree),
+    tc.Sum(dim=-2),
+    # layer 3
+    tc.LegendreCurve(intermediate_dim, 1, degree=degree),
+    tc.Sum(dim=-2),
+)
+```
+
+Since KANs are the primary use case for the `tc.Sum()` layer, we can omit the `dim=-2` argument, but it is provided
+here for clarity.
+
+## Advanced features
+
+The curves we provide here typically rely on their inputs to lie in a compact
+interval, typically [-1, 1]. Arbitrary inputs need to be normalized to this
+interval. We provide two simple out-of-the-box normalization strategies
+described below.
+
+## Rational scaling
+
+This is the default strategy — this strategy computes
+
+```math
+x \to \frac{x}{\sqrt{s^2 + x^2}},
+```
+
+and is based on the paper
+>Wang, Z.Q. and Guo, B.Y., 2004. Modified Legendre rational spectral method for the whole line. Journal of Computational Mathematics, pp.457-474.
+
+In Python it looks like this:
+
+```python
+tc.BSplineCurve(curve_dim, normalization_fn='rational', normalization_scale=s)
+```
+
+## Clamping
+
+The inputs are simply clipped to [-1, 1] after scaling, i.e.
+
+```math
+x \to \max(\min(1, x / s), -1)
+```
+
+In Python it looks like this:
+
+```python
+tc.BSplineCurve(curve_dim, normalization_fn='clamp', normalization_scale=s)
+```
+
+## Custom normalization
+
+Provide a custom function that maps its input to the designated range after
+scaling. Example:
+
+```python
+def erf_clamp(x: Tensor, scale: float = 1, out_min: float = -1, out_max: float = 1) -> Tensor:
+    mapped = torch.special.erf(x / scale)
+    return ((mapped + 1) * (out_max - out_min)) / 2 + out_min
+
+tc.BSplineCurve(curve_dim, normalization_fn=erf_clamp, normalization_scale=s)
+```
+
+## Example: B-Spline KAN with clamping
+
+A KAN based on rationally scaled B-Spline basis with the default scale of $s=1$:
+
+```python
+spline_kan = nn.Sequential(
+    # layer 1
+    tc.BSplineCurve(input_dim, intermediate_dim, knots_config=knots, normalization_fn='clamp'),
+    tc.Sum(),
+    # layer 2
+    tc.BSplineCurve(intermediate_dim, intermediate_dim, knots_config=knots, normalization_fn='clamp'),
+    tc.Sum(),
+    # layer 3
+    tc.BSplineCurve(intermediate_dim, 1, knots_config=knots, normalization_fn='clamp'),
+    tc.Sum(),
+)
+```
+
+### Legendre KAN with rational clamping
+
+```python
+import torchcurves as tc
+from torch import nn
+
+input_dim = 2
+intermediate_dim = 5
+degree = 5
+
+config = dict(degree=degree, normalization_fn="clamp")
+kan = nn.Sequential(
+    # layer 1
+    tc.LegendreCurve(input_dim, intermediate_dim, **config),
+    tc.Sum(),
+    # layer 2
+    tc.LegendreCurve(intermediate_dim, intermediate_dim, **config),
+    tc.Sum(),
+    # layer 3
+    tc.LegendreCurve(intermediate_dim, 1, **config),
+    tc.Sum(),
+)
+```
+
+
+## Development
+
+## Development Installation
+
+Using [uv](https://github.com/astral-sh/uv) (recommended):
+
+```bash
+# Clone the repository
+git clone https://github.com/alexshtf/torchcurves.git
+cd torchcurves
+
+# Create virtual environment and install
+uv venv
+uv sync --all-groups
+```
+
+## Running Tests
+
+```bash
+# Run all tests
+uv run pytest
+
+# Run with coverage
+uv run pytest --cov=torchcurves
+
+# Run specific test file
+uv run pytest tests/test_bspline.py -v
+```
+
+## Building the docs
+
+```bash
+# Prepare API docs
+cd docs
+make html
+```
+
+## Citation
+
+If you use this package in your research, please cite:
+
+```bibtex
+@software{torchcurves,
+  author = {Shtoff, Alex},
+  title = {torchcurves: Differentiable Parametric Curves in PyTorch},
+  year = {2025},
+  publisher = {GitHub},
+  url = {https://github.com/alexshtf/torchcurves}
+}
+```
+
+## References
+
+[1]: Ziming Liu, Yixuan Wang, Sachin Vaidya, Fabian Ruehle, James Halverson, Marin Soljacic, Thomas Y. Hou, Max Tegmark. "KAN: Kolmogorov–Arnold Networks." *ICLR* (2025). \
+[2]: Juergen Schmidhuber. "Learning to control fast-weight memories: An alternative to dynamic recurrent networks." *Neural Computation*, 4(1), pp.131-139. (1992) \
+[3]: Ashish Vaswani, Noam Shazeer, Niki Parmar, Jakob Uszkoreit, Llion Jones, Aidan N. Gomez, Łukasz Kaiser, and Illia Polosukhin. "Attention is all you need." *Advances in neural information processing systems* 30 (2017). \
+[4]: Alex Shtoff, Elie Abboud, Rotem Stram, and Oren Somekh. "Function Basis Encoding of Numerical Features in Factorization Machines." *Transactions on Machine Learning Research*. \
+[5]: Rügamer, David. "Scalable Higher-Order Tensor Product Spline Models." In *International Conference on Artificial Intelligence and Statistics*, pp. 1-9. PMLR, 2024. \
+[6]: Steffen Rendle. "Factorization machines." In *2010 IEEE International conference on data mining*, pp. 995-1000. IEEE, 2010.