Skip to content

[MOD-8365] Update datatypes and metric support in README #686

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

Merged
merged 6 commits into from
May 28, 2025

Conversation

meiravgri
Copy link
Collaborator

@meiravgri meiravgri commented May 28, 2025

This PR enhances the README with:

  • A metrics summary table describing supported distance metrics (L2, IP, Cosine) and their value ranges.
  • A short explanation of supported data types and SIMD usage.
  • Two detailed tables showing supported SIMD instruction sets for x86 and ARM architectures across all data types.

https://redislabs.atlassian.net/browse/MOD-8365

@meiravgri meiravgri changed the title readme update Update datatypes and metric support in README May 28, 2025
@meiravgri meiravgri requested a review from GuyAv46 May 28, 2025 09:26
@meiravgri meiravgri enabled auto-merge May 28, 2025 09:27
Copy link

codecov bot commented May 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.29%. Comparing base (0929890) to head (1598205).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #686   +/-   ##
=======================================
  Coverage   96.29%   96.29%           
=======================================
  Files         111      111           
  Lines        6288     6288           
=======================================
  Hits         6055     6055           
  Misses        233      233           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@meiravgri meiravgri added this pull request to the merge queue May 28, 2025
@meiravgri meiravgri changed the title Update datatypes and metric support in README [MOD-8365] Update datatypes and metric support in README May 28, 2025
Merged via the queue into main with commit 5ba2efa May 28, 2025
19 checks passed
@meiravgri meiravgri deleted the meiravg_update_readme branch May 28, 2025 11:45
Copy link

Backport failed for 8.0, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 8.0
git worktree add -d .worktree/backport-686-to-8.0 origin/8.0
cd .worktree/backport-686-to-8.0
git switch --create backport-686-to-8.0
git cherry-pick -x 5ba2efa9d22a7cc3169d981a104404586d14b9ba

meiravgri added a commit that referenced this pull request May 28, 2025
* readme update

* Update README.md

* Update README.md

* Update README.md

* skip spellcheck

* upadte spellcheckwordlist

(cherry picked from commit 5ba2efa)
github-merge-queue bot pushed a commit that referenced this pull request May 28, 2025
…#687)

Update datatypes and metric support in README (#686)

* readme update

* Update README.md

* Update README.md

* Update README.md

* skip spellcheck

* upadte spellcheckwordlist

(cherry picked from commit 5ba2efa)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants