Method from_string

vicinity/utils.py:68–91

Convert a string or Metric enum to a Metric enum member.

(cls, metric: str | Metric)

    @classmethod
    def from_string(cls, metric: str | Metric) -> Metric:
        """Convert a string or Metric enum to a Metric enum member."""
        if isinstance(metric, cls):
            return metric
        if isinstance(metric, str):
            mapping = {
                "cos": cls.COSINE,
                "cosine": cls.COSINE,
                "dot": cls.COSINE,
                "euclidean": cls.EUCLIDEAN,
                "l2": cls.EUCLIDEAN,
                "manhattan": cls.MANHATTAN,
                "l1": cls.MANHATTAN,
                "inner_product": cls.INNER_PRODUCT,
                "ip": cls.INNER_PRODUCT,
                "l2sq": cls.L2_SQUARED,
                "l2_squared": cls.L2_SQUARED,
                "hamming": cls.HAMMING,
                "tanimoto": cls.TANIMOTO,
            }
            metric_str = metric.lower()
            if metric_str in mapping:
                return mapping[metric_str]
        raise ValueError(f"Unsupported metric: {metric}")