Skip to main content

Differentiable curve and surface similarity measures.

Project description

GeoSimilarity Logo with text on the side.

GeoSimilarity is a differentiable curve and surface similarity loss function library.

It is built on top of PyTorch and is designed with modularity and extensibility in mind.

[!NOTE]
We are in the very early stages of development and are inviting domain experts for collaboration.

For a flavor of the documentation please refer: Documentation Webpage

Inviting Collaborators

We are in the very early stages of development are are inviting collaborators for:

  • Code Optimization: Benchmark your results and show a clear improvement.
  • Novel Loss Functions: Developing new curve/surface/point cloud similarity measures.
  • Testing: Incorporating testing codes.
  • Improving Documentation: Improving doc-string clarity and including doc tests. Also for improving the documentation website and adding explanations of similarity measures.

We'll use Github issues for tracking pull requests and bugs.

Installation

To pip install run:

$ pip install geosimilarity

Basic Usage

Given a candidate curve $Xc$ and a target curve $Xt$ we can measure the similarity using a given measure as follows:

import torch
import geosimilarity as gs

Xc = torch.randn(10, 2, requires_grad = True)
Xt = torch.randn(10, 2)

# Define a loss object and compute the similarity between curves
loss_fn = gs.MSELoss()
loss = loss_fn(Xc, Xt)

# To modify Xc to fit the target use autograd capacity for gradient stepping
loss.backward()

License

Distributed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

geosimilarity-0.0.1-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file geosimilarity-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: geosimilarity-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.0

File hashes

Hashes for geosimilarity-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3ad218fec7a979f81f560c943df359284547eb186c1c527b2910f25120695111
MD5 7e0172a738a93385a36cd8ab09c221dc
BLAKE2b-256 8dde065c49d6d947422274507c6e9ccaf7b6c11c8e35742beb88ab221ce47562

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page