Skip to main content

Neural network-based string similarity using squared Euclidean approximation to Levenshtein distance

Project description

megashtein

In their paper "Deep Squared Euclidean Approximation to the Levenshtein Distance for DNA Storage", Guo et al. explore techniques for using a neural network to embed sequences in such a way that the squared Euclidean distance between embeddings approximates the Levenshtein distance between the original sequences. This implementation also takes techniques from "Levenshtein Distance Embeddings with Poisson Regression for DNA Storage" by Wei et al. (2023).

This is valuable because there are excellent libraries for doing fast GPU accelerated searches for the K nearest neighbors of vectors, like faiss. Algorithms like HNSW allow us to do these searches in logarithmic time, where a brute force levenshtein distance based fuzzy search would need to run in exponential time.

This repo contains a PyTorch implementation of the core ideas from Guo's paper, adapted for ASCII sequences rather than DNA sequences. The implementation includes:

  • A convolutional neural network architecture for sequence embedding
  • Training using Poisson regression loss (PNLL) as described in the paper
  • Synthetic data generation with controlled edit distance relationships
  • Model saving and loading functionality

The trained model learns to embed ASCII strings such that the squared Euclidean distance between embeddings approximates the true Levenshtein distance between the strings.

Model Architecture

  • Base Architecture: Convolutional Neural Network with embedding layer
  • Input: ASCII sequences up to 80 characters (padded with null characters)
  • Output: 80-dimensional dense embeddings
  • Vocab Size: 128 (ASCII character set)
  • Embedding Dimension: 140

The model uses a 5-layer CNN with average pooling followed by fully connected layers to produce fixed-size embeddings from variable-length ASCII sequences.

Installation

pip install megashtein

Usage

import torch
from megashtein import load_model, embed_string

# Load the pre-trained model
model = load_model()

# Example usage
text1 = "hello world"
text2 = "hello word"

# Embed strings
emb1 = embed_string(model, text1)
emb2 = embed_string(model, text2)

# Compute approximate edit distance
approx_distance = torch.sum((emb1 - emb2) ** 2).item()
print(f"Approximate edit distance: {approx_distance}")

Training Details

The model is trained using:

  • Loss Function: Poisson Negative Log-Likelihood (PNLL)
  • Optimizer: AdamW with learning rate 0.000817
  • Batch Size: 32
  • Sequence Length: 80 characters (fixed)
  • Synthetic Data: Pairs of ASCII strings with known Levenshtein distances

Use Cases

  • Fuzzy String Search: Find similar strings in large text collections
  • Text Clustering: Group similar texts based on edit distance
  • Data Deduplication: Identify near-duplicate text entries
  • Approximate String Matching: Fast similarity search with controllable accuracy

Limitations

  • Fixed Length: Input sequences must be exactly 80 characters (padded/truncated)
  • ASCII Only: Limited to ASCII character set (0-127)
  • Approximation: Provides approximate rather than exact edit distances

Project details


Download files

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

Source Distribution

megashtein-0.1.4.tar.gz (543.7 kB view details)

Uploaded Source

Built Distribution

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

megashtein-0.1.4-py3-none-any.whl (514.9 kB view details)

Uploaded Python 3

File details

Details for the file megashtein-0.1.4.tar.gz.

File metadata

  • Download URL: megashtein-0.1.4.tar.gz
  • Upload date:
  • Size: 543.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for megashtein-0.1.4.tar.gz
Algorithm Hash digest
SHA256 24efc29f1bc3d0cb7cbca3c6621a946fb0bf1fa5c2b9903d7b05c33c09965e2d
MD5 5eafc71bcb56988f09ca6d6f2e56101f
BLAKE2b-256 62830782dc25b26f78a10d73f4bc29b6a59c048da8d82a2fc8d5761b11611339

See more details on using hashes here.

Provenance

The following attestation bundles were made for megashtein-0.1.4.tar.gz:

Publisher: publish.yml on Sawyer-Powell/megashtein

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file megashtein-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: megashtein-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 514.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for megashtein-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 df10eb545644a36a5d59da39e40261eb16db84479bbddedd94fe68286a84fc08
MD5 c56436ef812bdbfc05a5904906881054
BLAKE2b-256 6ba2d7ad30533332d284935cce6628a7dd16f564681dc340e16b97c3e42b7e28

See more details on using hashes here.

Provenance

The following attestation bundles were made for megashtein-0.1.4-py3-none-any.whl:

Publisher: publish.yml on Sawyer-Powell/megashtein

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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