Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document what search score mean #103

Closed
khoroshevskyi opened this issue Apr 9, 2024 · 3 comments
Closed

Document what search score mean #103

khoroshevskyi opened this issue Apr 9, 2024 · 3 comments
Assignees
Labels
docs solved Something that is solved

Comments

@khoroshevskyi
Copy link
Member

khoroshevskyi commented Apr 9, 2024

We should document somewhere what the score means; what is its range? From -1 to 1? Is it cosine similarity? Probably in the docstring on the search endpoint

@khoroshevskyi khoroshevskyi changed the title we should document somewhere what the score means; what is its range? From -1 to 1? Is it cosine similarity? Probably in the docstring on the search endpoint Document what search score mean Apr 9, 2024
@nsheff nsheff added this to the v0.5.0 milestone May 24, 2024
@nsheff
Copy link
Member

nsheff commented May 24, 2024

  • also in the user interface, which is where most people will encounter this score

@khoroshevskyi
Copy link
Member Author

khoroshevskyi commented May 28, 2024

Add docs to:

  • Geniml docs
  • Bedhost
  • UI (small button)

@ClaudeHu
Copy link
Member

I edited the doc of geniml on a newly created branch, which tells that the default distance metrics is cosine similarity, and also navigates to other distance options of Qdrant and hnswlib.

@khoroshevskyi khoroshevskyi removed this from the v0.5.0 milestone Jul 16, 2024
@khoroshevskyi khoroshevskyi added the solved Something that is solved label Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs solved Something that is solved
Projects
None yet
Development

No branches or pull requests

3 participants