swamauri_metric_wasserstein 0.11.0.dev1

Wasserstein metric plugin for Swarmauri vector comparisons.

This package is deprecated and will be removed from the active Swarmauri workspace by 0.12.0. Use it only as a compatibility shim while migrating away from the deprecated Distance contract.

Swamauri Metric Wasserstein

swamauri_metric_wasserstein provides a Swarmauri-compatible metric class for computing the first Wasserstein distance (Earth Mover's Distance) between numeric vectors.

Preferred Replacement

• Preferred package: swarmauri_standard
• Current state: no active standalone Wasserstein replacement package exists in the workspace.
• Migration path: keep this deprecated package only for compatibility, or vendor a project-specific metric until a correctly named active package is published.

Features

• Implements WassersteinMetric as a MetricBase plugin.
• Computes distance using a built-in pure-Python 1D Wasserstein implementation.
• Includes helper methods for batched distances and similarities.
• Supports Python 3.10, 3.11, and 3.12.

Installation

uv pip install swamauri_metric_wasserstein

pip install swamauri_metric_wasserstein

Usage

from swamauri_metric_wasserstein import WassersteinMetric
from swarmauri_standard.vectors.Vector import Vector

vector_a = Vector(value=[0.0, 1.0, 2.0])
vector_b = Vector(value=[0.0, 1.0, 2.0])

distance_calculator = WassersteinMetric()

distance = distance_calculator.distance(vector_a, vector_b)
similarity = distance_calculator.similarity(vector_a, vector_b)

print(f"Distance: {distance}")
print(f"Similarity: {similarity}")

Want to help?

If you want to contribute to swarmauri-sdk, read up on our guidelines for contributing that will help you get started.