redis / redis-om-python

Object mapping, and more, for Redis and Python
MIT License
1.07k stars 108 forks source link

Add support for KNN vector similarity search #513

Closed Pwuts closed 1 year ago

Pwuts commented 1 year ago

Added components

Changed components

Pwuts commented 1 year ago

@dvora-h @chayim 0:)

Pwuts commented 1 year ago

@chayim where should I add instructions for using this feature?

chayim commented 1 year ago

IMHO we should start a separate vectorsimilarity doc... @elena-kolevska given what you're up to - any preference?

elena-kolevska commented 1 year ago

Looping in @bsbodden, who's starting to work on a VSS quickstart for redis.io.

Pwuts commented 1 year ago

bump

codecov-commenter commented 1 year ago

Codecov Report

Patch coverage: 70.10% and project coverage change: -0.82 :warning:

Comparison is base (70f6401) 78.94% compared to head (583ae4a) 78.13%.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #513 +/- ## ========================================== - Coverage 78.94% 78.13% -0.82% ========================================== Files 14 14 Lines 1178 1267 +89 ========================================== + Hits 930 990 +60 - Misses 248 277 +29 ``` | Flag | Coverage Δ | | |---|---|---| | unit | `78.13% <70.10%> (-0.82%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=redis#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://app.codecov.io/gh/redis/redis-om-python/pull/513?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=redis) | Coverage Δ | | |---|---|---| | [aredis\_om/\_\_init\_\_.py](https://app.codecov.io/gh/redis/redis-om-python/pull/513?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=redis#diff-YXJlZGlzX29tL19faW5pdF9fLnB5) | `100.00% <ø> (ø)` | | | [aredis\_om/model/\_\_init\_\_.py](https://app.codecov.io/gh/redis/redis-om-python/pull/513?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=redis#diff-YXJlZGlzX29tL21vZGVsL19faW5pdF9fLnB5) | `100.00% <ø> (ø)` | | | [aredis\_om/model/model.py](https://app.codecov.io/gh/redis/redis-om-python/pull/513?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=redis#diff-YXJlZGlzX29tL21vZGVsL21vZGVsLnB5) | `85.30% <70.10%> (-1.79%)` | :arrow_down: |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

XChikuX commented 1 year ago

Okay, it's been more than a month. And this hasn't been merged even though all that's being corrected are type hints. @chayim, I'm aware you are a very busy individual. Please spare 5 minutes of your busy schedule for approving this!

chayim commented 1 year ago

Hi folks. I just merged in #534 so that we can have a CI that is properly reflective and runs this, and tests. That was the first step.

Logic wise, this looks proper, and as if it fits with the rest of this library. Merging in the master changes, and giving it another look.

I'm pro merging this - and issuing a release.