Feature: Metrics cheatsheet in the docs

[tnibler]

Describe what you are looking for

I regularly need to come back and check exact behavior/definitions of metrics, notably IP, cos, L2 (which are kindof the same, but also not quite). There's a couple of other issues (#13, #258) where some details were unclear to others too.

A tiny table summarizing how inputs should be normalized, how they are normalized internally and the formula for the Match.distance you get back (just dot product? normalized then dot? 1 - dot?) would be super handy.

Thank you :)

Can you contribute to the implementation?

• I can contribute

Is your feature request specific to a certain interface?

It applies to everything

Contact Details

No response

Is there an existing issue for this?

• I have searched the existing issues

Code of Conduct

• I agree to follow this project's Code of Conduct

[ashvardanian]

Thanks for suggestion, @tnibler! I'll try to make the docs of v3 clearer about the metrics, but feel free to suggest docs patches in the meantime - I'm ready to merge 😉