quaterion.distances package

Submodules

• quaterion.distances.base_distance module
  • BaseDistance
    • BaseDistance.distance()
    • BaseDistance.distance_matrix()
    • BaseDistance.similarity()
    • BaseDistance.similarity_matrix()
• quaterion.distances.cosine module
  • Cosine
    • Cosine.distance()
    • Cosine.distance_matrix()
    • Cosine.similarity()
    • Cosine.similarity_matrix()
• quaterion.distances.dot_product module
  • DotProduct
    • DotProduct.distance()
    • DotProduct.distance_matrix()
    • DotProduct.similarity()
    • DotProduct.similarity_matrix()
• quaterion.distances.euclidean module
  • Euclidean
    • Euclidean.distance()
    • Euclidean.distance_matrix()
    • Euclidean.similarity()
    • Euclidean.similarity_matrix()
• quaterion.distances.manhattan module
  • Manhattan
    • Manhattan.distance()
    • Manhattan.distance_matrix()
    • Manhattan.similarity()
    • Manhattan.similarity_matrix()

Module contents

class Distance(value)

Bases: str, Enum

An enumerator to pass distance metric names across the package.

static get_by_name(name: str) → BaseDistance

A simple utility method to get the distance class by name.

You can pass a value from Distance enum or its string representation as an argument.

COSINE = 'cosine'

DOT_PRODUCT = 'dot_product'

EUCLIDEAN = 'euclidean'

MANHATTAN = 'manhattan'