KristofferC / NearestNeighbors.jl

High performance nearest neighbor data structures (KDTree and BallTree) and algorithms for Julia.
Other
413 stars 65 forks source link

README.md Misleading Custom Metric Documentation #152

Closed scoopxyz closed 2 months ago

scoopxyz commented 2 years ago

The README seems to claim that custom Metrics are supported for the metric parameter, but this is not true for KDTree: https://github.com/KristofferC/NearestNeighbors.jl/blob/master/README.md?plain=1#L35

It is explicitlly limited to the available options in the MinkowskiMetric type: const MinkowskiMetric = Union{Euclidean,Chebyshev,Cityblock,Minkowski,WeightedEuclidean,WeightedCityblock,WeightedMinkowski}

This is somewhat explained earlier in the README, but adding this to the parameter definition would help.